Whoosh 3.1.0 documentation

Whoosh was created by Matt Chaput. You can view outstanding issues on the Whoosh Bitbucket page and get help on the Whoosh mailing list.

Contents

• Release notes
  • Whoosh 2.x release notes
  • Whoosh 1.x release notes
  • Whoosh 0.3 release notes
• Quick start
  • A quick introduction
  • The Index and Schema objects
  • The IndexWriter object
  • The Searcher object
• Adding full-text search to your Python app
  • Install
  • When should I use Whoosh?
  • A complete, minimal example
  • Keeping the index in sync with your data
  • Better search results
  • Flask integration
  • Django integration
  • Whoosh vs. SQLite FTS5 and other options
  • Where to go next
• Cookbook
  • Quick start
  • A guided tour
  • “Did you mean …?” spelling correction
  • Autocomplete / search-as-you-type
  • Whoosh vs. SQLite FTS5
  • Faceted navigation (filter sidebar with counts)
  • Highlighting and snippets
  • Custom analyzers (build your own text pipeline)
  • Custom scoring & sorting (control the ranking)
  • Closing indexes cleanly (and avoiding Windows file-lock errors)
  • A command-line folder search tool
  • A full-text search API with FastAPI
  • Migrating from Whoosh 2.x / whoosh-reloaded
• Introduction to Whoosh
  • About Whoosh
  • What is Whoosh?
  • What can Whoosh do for you?
  • Getting help with Whoosh
• Glossary
• Designing a schema
  • About schemas and fields
  • Built-in field types
  • Creating a Schema
  • Modifying the schema after indexing
  • Dynamic fields
  • Advanced schema setup
• How to index documents
  • Creating an Index object
  • Clearing the index
  • Indexing documents
  • Merging segments
  • Deleting documents
  • Updating documents
  • Incremental indexing
  • Clearing the index
• How to search
  • The Searcher object
  • Results object
  • Scoring and sorting
  • Highlighting snippets and More Like This
  • Filtering results
  • Which terms from my query matched?
  • Collapsing results
  • Time limited searches
  • Convenience methods
  • Combining Results objects
• Parsing user queries
  • Overview
  • Using the default parser
  • Common customizations
  • Advanced customization
• The default query language
  • Overview
  • Individual terms and phrases
  • Boolean operators
  • Fields
  • Inexact terms
  • Ranges
  • Boosting query elements
  • Making a term from literal text
• Indexing and parsing dates/times
  • Indexing dates
  • Parsing date queries
  • About time zones and basetime
  • Date parser notes
  • Limitations
• Query objects
• About analyzers
  • Overview
  • Using analyzers
  • Advanced Analysis
• Stemming, variations, and accent folding
  • The problem
  • Stemming
  • Variations
  • Lemmatization
  • Character folding
• Indexing and searching N-grams
  • Overview
• Sorting and faceting
  • Overview
  • Sorting
  • Grouping
  • Facet types
  • MultiFacet
  • Missing values
  • Using overlapping groups
  • Using a custom sort order
  • Expert: writing your own facet
• How to create highlighted search result excerpts
  • Overview
  • Requirements
  • How to
  • The character limit
  • Customizing the highlights
  • Highlighter object
  • Speeding up highlighting
  • Using the low-level API
• Query expansion and Key word extraction
  • Overview
  • Usage
  • Expansion models
• “Did you mean… ?” Correcting errors in user queries
  • Overview
  • Pulling suggestions from an indexed field
  • Pulling suggestions from a word list
  • Merging two or more correctors
  • Correcting user queries
• Field caches
  • Customizing cache behaviour
  • Creating a custom caching policy
• Tips for speeding up batch indexing
  • Overview
  • StemmingAnalyzer cache
  • The limitmb parameter
  • The procs parameter
  • The multisegment parameter
• Concurrency, locking, and versioning
  • Concurrency
  • Locking
  • Versioning
• Indexing and searching document hierarchies
  • Overview
  • Using nested document indexing
  • Using query-time joins
• Whoosh recipes
  • General
  • Analysis
  • Searching
  • Shortcuts
  • Sorting and scoring
  • Results
  • Global information
• Whoosh API
  • analysis module
  • codec.base module
  • collectors module
  • columns module
  • fields module
  • filedb.filestore module
  • filedb.filetables module
  • filedb.structfile module
  • formats module
  • highlight module
  • support.bitvector module
  • index module
  • lang.morph_en module
  • lang.porter module
  • lang.wordnet module
  • matching module
  • qparser module
  • query module
  • reading module
  • scoring module
  • searching module
  • sorting module
  • spelling module
  • support.charset module
  • support.levenshtein module
  • util module
  • writing module
• Technical notes
  • How to implement a new backend
  • filedb notes

Indices and tables

• Index

• Module Index

• Search Page