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
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
  - Indexing and storing different values for the same field
  - Finishing adding documents
- Merging segments
- Deleting documents
- Updating documents
- Incremental indexing
- Clearing the index
How to search
- The Searcher object
- Results object
- Scoring and sorting
  - Scoring
  - 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
  - PinpointFragmenter
  - PinpointFragmenter limitations
- Using the low-level API
  - Usage
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
  - Lock files
- Versioning
Indexing and searching document hierarchies
- Overview
- Using nested document indexing
- Using query-time joins
Whoosh recipes
- General
  - Get the stored fields for a document from the document number
- Analysis
  - Eliminate words shorter/longer than N
  - Allow optional case-sensitive searches
- Searching
  - Find every document
  - iTunes-style search-as-you-type
- Shortcuts
  - Look up documents by a field value
- Sorting and scoring
  - Score results based on the position of the matched term
- Results
  - How many hits were there?
  - Which terms matched in each hit?
- Global information
Whoosh API
- analysis module
  - Analyzers
  - Tokenizers
  - Filters
  - Token classes and functions
- codec.base module
  - Classes
- collectors module
  - Base classes
  - Basic collectors
  - Wrappers
- columns module
  - Base classes
  - Basic columns
  - Technical columns
  - Experimental columns
- fields module
  - Schema class
  - FieldType base class
  - Pre-made field types
  - Exceptions
- filedb.filestore module
  - Base class
  - Implementation classes
  - Helper functions
  - Exceptions
- filedb.filetables module
  - Hash file
  - Ordered Hash file
- filedb.structfile module
  - Classes
- formats module
  - Base class
  - Formats
- highlight module
  - Manual highlighting
  - Fragmenters
  - Scorers
  - Formatters
  - Utility classes
- support.bitvector module
  - Base classes
  - Implementation classes
- index module
  - Functions
  - Base class
  - Implementation
  - Exceptions
- lang.morph_en module
- lang.porter module
- lang.wordnet module
  - Thesaurus
  - Low-level functions
- matching module
  - Matchers
  - Exceptions
- qparser module
  - Parser object
    - Pre-made configurations
  - Plug-ins
  - Syntax node objects
- query module
  - Base classes
  - Query classes
  - Binary queries
  - Span queries
  - Special queries
  - Exceptions
- reading module
  - Classes
  - Exceptions
- scoring module
  - Base classes
  - Scoring algorithm classes
  - Scoring utility classes
- searching module
  - Searching classes
  - Results classes
  - Exceptions
- sorting module
  - Base types
  - Facet types
  - Facets object
  - FacetType objects
- spelling module
  - Corrector objects
  - QueryCorrector objects
- support.charset module
- support.levenshtein module
- util module
- writing module
  - Writer
  - Utility writers
  - Exceptions
Technical notes
- How to implement a new backend
  - Index
  - IndexWriter
  - IndexReader
  - Matcher
- filedb notes
  - Files created

Python Module Index


	w
	`whoosh`
	`whoosh.analysis`
	`whoosh.codec.base`
	`whoosh.collectors`
	`whoosh.columns`
	`whoosh.fields`
	`whoosh.filedb.filestore`
	`whoosh.filedb.filetables`
	`whoosh.filedb.structfile`
	`whoosh.formats`
	`whoosh.highlight`
	`whoosh.idsets`
	`whoosh.index`
	`whoosh.lang.morph_en`
	`whoosh.lang.porter`
	`whoosh.lang.wordnet`
	`whoosh.matching`
	`whoosh.qparser`
	`whoosh.query`
	`whoosh.reading`
	`whoosh.scoring`
	`whoosh.searching`
	`whoosh.sorting`
	`whoosh.spelling`
	`whoosh.support.charset`
	`whoosh.support.levenshtein`
	`whoosh.util`
	`whoosh.writing`

Python Module Index

Python Module Index

Table Of Contents

Python Module Index