Whoosh 2.7.4 documentation

Release notes

Release notes
Whoosh 2.7.4 documentation
Whoosh 2.x release notes 

Table Of Contents

  • Release notes
    • Whoosh 2.x release notes
      • Whoosh 2.7
      • Whoosh 2.5
      • Whoosh 2.4
      • Whoosh 2.3.2
      • Whoosh 2.3.1
      • Whoosh 2.3
      • Whoosh 2.2
      • Whoosh 2.1
      • Whoosh 2.0
        • Improvements
        • Compatibility
    • Whoosh 1.x release notes
      • Whoosh 1.8.3
      • Whoosh 1.8.2
      • Whoosh 1.8.1
      • Whoosh 1.8
      • Whoosh 1.7.7
      • Whoosh 1.7
      • Whoosh 1.6
      • Whoosh 1.5
      • Whoosh 1.3
      • Whoosh 1.2
      • Whoosh 1.0
      • User API changes
      • Misc
    • 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
      • Field boosts
      • Field types
      • Formats
      • Vectors
  • 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
      • Searching for any terms instead of all terms by default
      • Letting the user search multiple fields by default
      • Simplifying the query language
      • Changing the AND, OR, ANDNOT, ANDMAYBE, and NOT syntax
      • Adding less-than, greater-than, etc.
      • Adding fuzzy term queries
      • Allowing complex phrase queries
    • Advanced customization
      • QueryParser arguments
      • Configuring plugins
      • Creating custom operators
  • 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
      • Setting the base datetime
      • Registering an error callback
      • Using free parsing
      • Parsable formats
    • Limitations
  • Query objects
  • About analyzers
    • Overview
    • Using analyzers
    • Advanced Analysis
      • Token objects
      • Token setting attributes
      • Token information attributes
      • Performing different analysis for indexing and query parsing
      • Stop words
      • Renumbering term positions
      • Removing or leaving stop words
      • Implementation notes
  • Stemming, variations, and accent folding
    • The problem
    • Stemming
    • Variations
    • Lemmatization
    • Character folding
  • Indexing and searching N-grams
    • Overview
  • Sorting and faceting
    • Overview
    • Sorting
      • Making fields sortable
      • About column types
      • Using a COLUMN field for custom sort keys
      • Making existing fields sortable
      • Sorting search results
      • Examples
      • Accessing column values
    • Grouping
      • The groupedby keyword argument
      • Examples
      • Getting the faceted groups
    • Facet types
      • FieldFacet
      • QueryFacet
      • RangeFacet
      • DateRangeFacet
      • ScoreFacet
      • FunctionFacet
      • StoredFieldFacet
    • 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
      • Number of fragments
      • Fragment size
      • Fragmenter
      • Scorer
      • Order
      • Formatter
    • 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
      • Indexing
      • NestedParent query
      • NestedChildren query
      • Deleting and updating hierarchical documents
    • 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
      • How many documents are in the index?
      • What fields are in the index?
      • Is term X in the index?
      • How many times does term X occur in the index?
      • Is term X in document Y?
  • Whoosh API
    • analysis module
      • Analyzers
        • IDAnalyzer()
        • KeywordAnalyzer()
        • RegexAnalyzer()
        • SimpleAnalyzer()
        • StandardAnalyzer()
        • StemmingAnalyzer()
        • FancyAnalyzer()
        • NgramAnalyzer()
        • NgramWordAnalyzer()
        • LanguageAnalyzer()
      • Tokenizers
        • IDTokenizer
        • RegexTokenizer
        • CharsetTokenizer
        • SpaceSeparatedTokenizer()
        • CommaSeparatedTokenizer()
        • NgramTokenizer
        • PathTokenizer
      • Filters
        • PassFilter
        • LoggingFilter
        • MultiFilter
        • TeeFilter
        • ReverseTextFilter
        • LowercaseFilter
        • StripFilter
        • StopFilter
        • StemFilter
        • CharsetFilter
        • NgramFilter
        • IntraWordFilter
        • CompoundWordFilter
        • BiWordFilter
        • ShingleFilter
        • DelimitedAttributeFilter
        • DoubleMetaphoneFilter
        • SubstitutionFilter
      • Token classes and functions
        • Token
        • unstopped()
    • codec.base module
      • Classes
        • Codec
        • PerDocumentWriter
        • FieldWriter
        • PostingsWriter
          • PostingsWriter.written()
        • TermsReader
        • PerDocumentReader
          • PerDocumentReader.all_doc_ids()
        • Segment
          • Segment.create_file()
          • Segment.delete_document()
          • Segment.deleted_count()
          • Segment.doc_count()
          • Segment.doc_count_all()
          • Segment.has_deletions()
          • Segment.is_deleted()
          • Segment.open_file()
    • collectors module
      • Base classes
        • Collector
          • Collector.all_ids()
          • Collector.collect()
          • Collector.collect_matches()
          • Collector.computes_count()
          • Collector.count()
          • Collector.finish()
          • Collector.matches()
          • Collector.prepare()
          • Collector.remove()
          • Collector.results()
          • Collector.set_subsearcher()
          • Collector.sort_key()
        • ScoredCollector
          • ScoredCollector.collect()
          • ScoredCollector.matches()
          • ScoredCollector.prepare()
          • ScoredCollector.sort_key()
        • WrappingCollector
          • WrappingCollector.all_ids()
          • WrappingCollector.collect()
          • WrappingCollector.collect_matches()
          • WrappingCollector.count()
          • WrappingCollector.finish()
          • WrappingCollector.matches()
          • WrappingCollector.prepare()
          • WrappingCollector.remove()
          • WrappingCollector.results()
          • WrappingCollector.set_subsearcher()
          • WrappingCollector.sort_key()
      • Basic collectors
        • TopCollector
        • UnlimitedCollector
        • SortingCollector
      • Wrappers
        • FilterCollector
        • FacetCollector
        • CollapseCollector
        • TimeLimitCollector
        • TermsCollector
    • columns module
      • Base classes
        • Column
          • Column.default_value()
          • Column.reader()
          • Column.stores_lists()
          • Column.writer()
        • ColumnWriter
        • ColumnReader
      • Basic columns
        • VarBytesColumn
        • FixedBytesColumn
        • RefBytesColumn
        • NumericColumn
      • Technical columns
        • BitColumn
        • CompressedBytesColumn
        • StructColumn
        • PickleColumn
      • Experimental columns
        • ClampedNumericColumn
    • fields module
      • Schema class
        • Schema
          • Schema.add()
          • Schema.copy()
          • Schema.items()
          • Schema.names()
          • Schema.scorable_names()
          • Schema.stored_names()
        • SchemaClass
      • FieldType base class
        • FieldType
          • FieldType.clean()
          • FieldType.index()
          • FieldType.parse_query()
          • FieldType.parse_range()
          • FieldType.process_text()
          • FieldType.self_parsing()
          • FieldType.separate_spelling()
          • FieldType.sortable_terms()
          • FieldType.spellable_words()
          • FieldType.spelling_fieldname()
          • FieldType.subfields()
          • FieldType.supports()
          • FieldType.to_bytes()
          • FieldType.to_column_value()
          • FieldType.tokenize()
      • Pre-made field types
        • ID
        • IDLIST
        • STORED
        • KEYWORD
        • TEXT
        • NUMERIC
        • DATETIME
        • BOOLEAN
        • NGRAM
        • NGRAMWORDS
      • Exceptions
        • FieldConfigurationError
        • UnknownFieldError
    • filedb.filestore module
      • Base class
        • Storage
          • Storage.close()
          • Storage.create()
          • Storage.create_file()
          • Storage.create_index()
          • Storage.delete_file()
          • Storage.destroy()
          • Storage.file_exists()
          • Storage.file_length()
          • Storage.file_modified()
          • Storage.index_exists()
          • Storage.list()
          • Storage.lock()
          • Storage.open_file()
          • Storage.open_index()
          • Storage.optimize()
          • Storage.rename_file()
          • Storage.temp_storage()
      • Implementation classes
        • FileStorage
        • RamStorage
      • Helper functions
        • copy_storage()
        • copy_to_ram()
      • Exceptions
        • ReadOnlyError
    • filedb.filetables module
      • Hash file
        • HashWriter
          • HashWriter.add()
          • HashWriter.add_all()
        • HashReader
          • HashReader.all()
          • HashReader.open()
          • HashReader.ranges_for_key()
      • Ordered Hash file
        • OrderedHashWriter
        • OrderedHashReader
    • filedb.structfile module
      • Classes
        • StructFile
          • StructFile.close()
          • StructFile.flush()
          • StructFile.read_pickle()
          • StructFile.read_string()
          • StructFile.read_svarint()
          • StructFile.read_tagint()
          • StructFile.read_varint()
          • StructFile.write_byte()
          • StructFile.write_pickle()
          • StructFile.write_string()
          • StructFile.write_svarint()
          • StructFile.write_tagint()
          • StructFile.write_varint()
        • BufferFile
        • ChecksumFile
    • formats module
      • Base class
        • Format
          • Format.decode_as()
          • Format.decoder()
          • Format.supports()
          • Format.word_values()
      • Formats
        • Existence
        • Frequency
        • Positions
        • Characters
        • PositionBoosts
        • CharacterBoosts
    • highlight module
      • Manual highlighting
        • Highlighter
        • highlight()
      • Fragmenters
        • Fragmenter
          • Fragmenter.fragment_matches()
          • Fragmenter.fragment_tokens()
          • Fragmenter.must_retokenize()
        • WholeFragmenter
        • SentenceFragmenter
        • ContextFragmenter
        • PinpointFragmenter
      • Scorers
        • FragmentScorer
        • BasicFragmentScorer
      • Formatters
        • UppercaseFormatter
        • HtmlFormatter
        • GenshiFormatter
      • Utility classes
        • Fragment
    • support.bitvector module
      • Base classes
        • DocIdSet
          • DocIdSet.after()
          • DocIdSet.before()
          • DocIdSet.first()
          • DocIdSet.invert_update()
          • DocIdSet.last()
        • BaseBitSet
      • Implementation classes
        • BitSet
        • OnDiskBitSet
        • SortedIntSet
        • MultiIdSet
    • index module
      • Functions
        • create_in()
        • open_dir()
        • exists_in()
        • exists()
        • version_in()
        • version()
      • Base class
        • Index
          • Index.add_field()
          • Index.close()
          • Index.doc_count()
          • Index.doc_count_all()
          • Index.field_length()
          • Index.is_empty()
          • Index.last_modified()
          • Index.latest_generation()
          • Index.max_field_length()
          • Index.optimize()
          • Index.reader()
          • Index.refresh()
          • Index.remove_field()
          • Index.searcher()
          • Index.up_to_date()
          • Index.writer()
      • Implementation
        • FileIndex
      • Exceptions
        • LockError
        • IndexError
        • IndexVersionError
        • OutOfDateError
        • EmptyIndexError
    • lang.morph_en module
      • variations()
    • lang.porter module
      • stem()
    • lang.wordnet module
      • Thesaurus
        • Thesaurus
          • Thesaurus.from_file()
          • Thesaurus.from_filename()
          • Thesaurus.from_storage()
          • Thesaurus.synonyms()
          • Thesaurus.to_storage()
      • Low-level functions
        • parse_file()
        • synonyms()
        • make_index()
    • matching module
      • Matchers
        • Matcher
          • Matcher.all_ids()
          • Matcher.all_items()
          • Matcher.block_quality()
          • Matcher.children()
          • Matcher.copy()
          • Matcher.depth()
          • Matcher.id()
          • Matcher.is_active()
          • Matcher.items_as()
          • Matcher.matching_terms()
          • Matcher.max_quality()
          • Matcher.next()
          • Matcher.replace()
          • Matcher.reset()
          • Matcher.score()
          • Matcher.skip_to()
          • Matcher.skip_to_quality()
          • Matcher.spans()
          • Matcher.supports()
          • Matcher.supports_block_quality()
          • Matcher.term()
          • Matcher.term_matchers()
          • Matcher.value()
          • Matcher.value_as()
          • Matcher.weight()
        • NullMatcher
        • ListMatcher
        • WrappingMatcher
        • MultiMatcher
        • FilterMatcher
        • BiMatcher
        • AdditiveBiMatcher
        • UnionMatcher
        • DisjunctionMaxMatcher
        • IntersectionMatcher
        • AndNotMatcher
        • InverseMatcher
        • RequireMatcher
        • AndMaybeMatcher
        • ConstantScoreMatcher
      • Exceptions
        • ReadTooFar
        • NoQualityAvailable
    • qparser module
      • Parser object
        • QueryParser
          • QueryParser.add_plugin()
          • QueryParser.add_plugins()
          • QueryParser.default_set()
          • QueryParser.filterize()
          • QueryParser.filters()
          • QueryParser.multitoken_query()
          • QueryParser.parse()
          • QueryParser.process()
          • QueryParser.remove_plugin()
          • QueryParser.remove_plugin_class()
          • QueryParser.replace_plugin()
          • QueryParser.tag()
          • QueryParser.taggers()
          • QueryParser.term_query()
        • Pre-made configurations
          • MultifieldParser()
          • SimpleParser()
          • DisMaxParser()
      • Plug-ins
        • Plugin
          • Plugin.filters()
          • Plugin.taggers()
        • SingleQuotePlugin
        • PrefixPlugin
        • WildcardPlugin
        • RegexPlugin
        • BoostPlugin
        • GroupPlugin
        • EveryPlugin
        • FieldsPlugin
        • PhrasePlugin
        • RangePlugin
        • OperatorsPlugin
        • PlusMinusPlugin
        • GtLtPlugin
        • MultifieldPlugin
        • FieldAliasPlugin
        • CopyFieldPlugin
      • Syntax node objects
        • Base nodes
          • SyntaxNode
        • Nodes
          • FieldnameNode
          • TextNode
          • WordNode
          • RangeNode
          • MarkerNode
        • Group nodes
          • GroupNode
          • BinaryGroup
          • ErrorNode
          • AndGroup
          • OrGroup
          • AndNotGroup
          • AndMaybeGroup
          • DisMaxGroup
          • RequireGroup
          • NotGroup
        • Operators
          • Operator
          • PrefixOperator
          • PostfixOperator
          • InfixOperator
    • query module
      • Base classes
        • Query
          • Query.accept()
          • Query.all_terms()
          • Query.all_tokens()
          • Query.apply()
          • Query.children()
          • Query.copy()
          • Query.deletion_docs()
          • Query.docs()
          • Query.estimate_min_size()
          • Query.estimate_size()
          • Query.existing_terms()
          • Query.field()
          • Query.has_terms()
          • Query.is_leaf()
          • Query.is_range()
          • Query.iter_all_terms()
          • Query.leaves()
          • Query.matcher()
          • Query.normalize()
          • Query.replace()
          • Query.requires()
          • Query.simplify()
          • Query.terms()
          • Query.tokens()
          • Query.with_boost()
        • CompoundQuery
        • MultiTerm
        • ExpandingTerm
        • WrappingQuery
      • Query classes
        • Term
        • Variations
        • FuzzyTerm
        • Phrase
        • And
        • Or
        • DisjunctionMax
        • Not
        • Prefix
        • Wildcard
        • Regex
        • TermRange
        • NumericRange
        • DateRange
        • Every
        • NullQuery
      • Binary queries
        • Require
        • AndMaybe
        • AndNot
        • Otherwise
      • Span queries
        • Span
          • Span.merge()
        • SpanQuery
        • SpanFirst
        • SpanNear
        • SpanNear2
        • SpanNot
        • SpanOr
        • SpanContains
        • SpanBefore
        • SpanCondition
      • Special queries
        • NestedParent
        • NestedChildren
        • ConstantScoreQuery
      • Exceptions
        • QueryError
    • reading module
      • Classes
        • IndexReader
          • IndexReader.all_doc_ids()
          • IndexReader.all_stored_fields()
          • IndexReader.all_terms()
          • IndexReader.close()
          • IndexReader.codec()
          • IndexReader.column_reader()
          • IndexReader.corrector()
          • IndexReader.doc_count()
          • IndexReader.doc_count_all()
          • IndexReader.doc_field_length()
          • IndexReader.doc_frequency()
          • IndexReader.expand_prefix()
          • IndexReader.field_length()
          • IndexReader.field_terms()
          • IndexReader.first_id()
          • IndexReader.frequency()
          • IndexReader.generation()
          • IndexReader.has_deletions()
          • IndexReader.has_vector()
          • IndexReader.indexed_field_names()
          • IndexReader.is_deleted()
          • IndexReader.iter_docs()
          • IndexReader.iter_field()
          • IndexReader.iter_from()
          • IndexReader.iter_postings()
          • IndexReader.iter_prefix()
          • IndexReader.leaf_readers()
          • IndexReader.lexicon()
          • IndexReader.max_field_length()
          • IndexReader.min_field_length()
          • IndexReader.most_distinctive_terms()
          • IndexReader.most_frequent_terms()
          • IndexReader.postings()
          • IndexReader.segment()
          • IndexReader.storage()
          • IndexReader.stored_fields()
          • IndexReader.term_info()
          • IndexReader.terms_from()
          • IndexReader.terms_within()
          • IndexReader.vector()
          • IndexReader.vector_as()
        • MultiReader
        • TermInfo
          • TermInfo.doc_frequency()
          • TermInfo.max_id()
          • TermInfo.max_length()
          • TermInfo.max_weight()
          • TermInfo.min_id()
          • TermInfo.min_length()
          • TermInfo.weight()
      • Exceptions
        • TermNotFound
    • scoring module
      • Base classes
        • WeightingModel
          • WeightingModel.final()
          • WeightingModel.idf()
          • WeightingModel.scorer()
        • BaseScorer
          • BaseScorer.block_quality()
          • BaseScorer.max_quality()
          • BaseScorer.score()
          • BaseScorer.supports_block_quality()
        • WeightScorer
        • WeightLengthScorer
      • Scoring algorithm classes
        • BM25F
        • TF_IDF
        • Frequency
      • Scoring utility classes
        • FunctionWeighting
        • MultiWeighting
        • ReverseWeighting
    • searching module
      • Searching classes
        • Searcher
          • Searcher.boolean_context()
          • Searcher.collector()
          • Searcher.context()
          • Searcher.correct_query()
          • Searcher.doc_count()
          • Searcher.doc_count_all()
          • Searcher.docs_for_query()
          • Searcher.document()
          • Searcher.document_number()
          • Searcher.document_numbers()
          • Searcher.documents()
          • Searcher.get_parent()
          • Searcher.idf()
          • Searcher.key_terms()
          • Searcher.key_terms_from_text()
          • Searcher.more_like()
          • Searcher.postings()
          • Searcher.reader()
          • Searcher.refresh()
          • Searcher.search()
          • Searcher.search_page()
          • Searcher.search_with_collector()
          • Searcher.suggest()
          • Searcher.up_to_date()
      • Results classes
        • Results
          • Results.copy()
          • Results.docnum()
          • Results.docs()
          • Results.estimated_length()
          • Results.estimated_min_length()
          • Results.extend()
          • Results.facet_names()
          • Results.fields()
          • Results.filter()
          • Results.groups()
          • Results.has_exact_length()
          • Results.has_matched_terms()
          • Results.is_empty()
          • Results.items()
          • Results.key_terms()
          • Results.matched_terms()
          • Results.score()
          • Results.scored_length()
          • Results.upgrade()
          • Results.upgrade_and_extend()
        • Hit
          • Hit.fields()
          • Hit.highlights()
          • Hit.matched_terms()
          • Hit.more_like_this()
        • ResultsPage
          • ResultsPage.docnum()
          • ResultsPage.is_last_page()
          • ResultsPage.score()
      • Exceptions
        • NoTermsException
        • TimeLimit
    • sorting module
      • Base types
        • FacetType
          • FacetType.categorizer()
        • Categorizer
          • Categorizer.key_for()
          • Categorizer.key_to_name()
          • Categorizer.keys_for()
          • Categorizer.set_searcher()
      • Facet types
        • FieldFacet
        • QueryFacet
        • RangeFacet
        • DateRangeFacet
        • ScoreFacet
        • FunctionFacet
        • MultiFacet
        • StoredFieldFacet
      • Facets object
        • Facets
          • Facets.add_facet()
          • Facets.add_facets()
          • Facets.add_field()
          • Facets.add_query()
          • Facets.items()
          • Facets.names()
      • FacetType objects
        • FacetMap
          • FacetMap.add()
          • FacetMap.as_dict()
        • OrderedList
        • UnorderedList
        • Count
        • Best
    • spelling module
      • Corrector objects
        • Corrector
          • Corrector.suggest()
        • ReaderCorrector
        • MultiCorrector
      • QueryCorrector objects
        • QueryCorrector
          • QueryCorrector.correct_query()
        • SimpleQueryCorrector
        • Correction
    • support.charset module
      • default_charset
      • charset_table_to_dict()
    • support.levenshtein module
      • relative()
      • distance()
    • util module
      • fib()
      • make_binary_tree()
      • make_weighted_tree()
      • synchronized()
      • unclosed()
    • writing module
      • Writer
        • IndexWriter
          • IndexWriter.add_document()
          • IndexWriter.add_field()
          • IndexWriter.cancel()
          • IndexWriter.commit()
          • IndexWriter.delete_by_query()
          • IndexWriter.delete_by_term()
          • IndexWriter.delete_document()
          • IndexWriter.end_group()
          • IndexWriter.group()
          • IndexWriter.reader()
          • IndexWriter.remove_field()
          • IndexWriter.start_group()
          • IndexWriter.update_document()
      • Utility writers
        • BufferedWriter
          • BufferedWriter.add_document()
          • BufferedWriter.commit()
          • BufferedWriter.delete_document()
          • BufferedWriter.reader()
          • BufferedWriter.update_document()
        • AsyncWriter
          • AsyncWriter.add_document()
          • AsyncWriter.add_field()
          • AsyncWriter.cancel()
          • AsyncWriter.commit()
          • AsyncWriter.delete_by_term()
          • AsyncWriter.delete_document()
          • AsyncWriter.reader()
          • AsyncWriter.remove_field()
          • AsyncWriter.run()
          • AsyncWriter.update_document()
      • Exceptions
        • IndexingError
  • Technical notes
    • How to implement a new backend
      • Index
      • IndexWriter
      • IndexReader
      • Matcher
    • filedb notes
      • Files created
  • Release notes
    • Whoosh 2.x release notes
      • Whoosh 2.7
      • Whoosh 2.5
      • Whoosh 2.4
      • Whoosh 2.3.2
      • Whoosh 2.3.1
      • Whoosh 2.3
      • Whoosh 2.2
      • Whoosh 2.1
      • Whoosh 2.0
        • Improvements
        • Compatibility
    • Whoosh 1.x release notes
      • Whoosh 1.8.3
      • Whoosh 1.8.2
      • Whoosh 1.8.1
      • Whoosh 1.8
      • Whoosh 1.7.7
      • Whoosh 1.7
      • Whoosh 1.6
      • Whoosh 1.5
      • Whoosh 1.3
      • Whoosh 1.2
      • Whoosh 1.0
      • User API changes
      • Misc
    • 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
      • Field boosts
      • Field types
      • Formats
      • Vectors
  • 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
      • Searching for any terms instead of all terms by default
      • Letting the user search multiple fields by default
      • Simplifying the query language
      • Changing the AND, OR, ANDNOT, ANDMAYBE, and NOT syntax
      • Adding less-than, greater-than, etc.
      • Adding fuzzy term queries
      • Allowing complex phrase queries
    • Advanced customization
      • QueryParser arguments
      • Configuring plugins
      • Creating custom operators
  • 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
      • Setting the base datetime
      • Registering an error callback
      • Using free parsing
      • Parsable formats
    • Limitations
  • Query objects
  • About analyzers
    • Overview
    • Using analyzers
    • Advanced Analysis
      • Token objects
      • Token setting attributes
      • Token information attributes
      • Performing different analysis for indexing and query parsing
      • Stop words
      • Renumbering term positions
      • Removing or leaving stop words
      • Implementation notes
  • Stemming, variations, and accent folding
    • The problem
    • Stemming
    • Variations
    • Lemmatization
    • Character folding
  • Indexing and searching N-grams
    • Overview
  • Sorting and faceting
    • Overview
    • Sorting
      • Making fields sortable
      • About column types
      • Using a COLUMN field for custom sort keys
      • Making existing fields sortable
      • Sorting search results
      • Examples
      • Accessing column values
    • Grouping
      • The groupedby keyword argument
      • Examples
      • Getting the faceted groups
    • Facet types
      • FieldFacet
      • QueryFacet
      • RangeFacet
      • DateRangeFacet
      • ScoreFacet
      • FunctionFacet
      • StoredFieldFacet
    • 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
      • Number of fragments
      • Fragment size
      • Fragmenter
      • Scorer
      • Order
      • Formatter
    • 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
      • Indexing
      • NestedParent query
      • NestedChildren query
      • Deleting and updating hierarchical documents
    • 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
      • How many documents are in the index?
      • What fields are in the index?
      • Is term X in the index?
      • How many times does term X occur in the index?
      • Is term X in document Y?
  • Whoosh API
    • analysis module
      • Analyzers
        • IDAnalyzer()
        • KeywordAnalyzer()
        • RegexAnalyzer()
        • SimpleAnalyzer()
        • StandardAnalyzer()
        • StemmingAnalyzer()
        • FancyAnalyzer()
        • NgramAnalyzer()
        • NgramWordAnalyzer()
        • LanguageAnalyzer()
      • Tokenizers
        • IDTokenizer
        • RegexTokenizer
        • CharsetTokenizer
        • SpaceSeparatedTokenizer()
        • CommaSeparatedTokenizer()
        • NgramTokenizer
        • PathTokenizer
      • Filters
        • PassFilter
        • LoggingFilter
        • MultiFilter
        • TeeFilter
        • ReverseTextFilter
        • LowercaseFilter
        • StripFilter
        • StopFilter
        • StemFilter
        • CharsetFilter
        • NgramFilter
        • IntraWordFilter
        • CompoundWordFilter
        • BiWordFilter
        • ShingleFilter
        • DelimitedAttributeFilter
        • DoubleMetaphoneFilter
        • SubstitutionFilter
      • Token classes and functions
        • Token
        • unstopped()
    • codec.base module
      • Classes
        • Codec
        • PerDocumentWriter
        • FieldWriter
        • PostingsWriter
          • PostingsWriter.written()
        • TermsReader
        • PerDocumentReader
          • PerDocumentReader.all_doc_ids()
        • Segment
          • Segment.create_file()
          • Segment.delete_document()
          • Segment.deleted_count()
          • Segment.doc_count()
          • Segment.doc_count_all()
          • Segment.has_deletions()
          • Segment.is_deleted()
          • Segment.open_file()
    • collectors module
      • Base classes
        • Collector
          • Collector.all_ids()
          • Collector.collect()
          • Collector.collect_matches()
          • Collector.computes_count()
          • Collector.count()
          • Collector.finish()
          • Collector.matches()
          • Collector.prepare()
          • Collector.remove()
          • Collector.results()
          • Collector.set_subsearcher()
          • Collector.sort_key()
        • ScoredCollector
          • ScoredCollector.collect()
          • ScoredCollector.matches()
          • ScoredCollector.prepare()
          • ScoredCollector.sort_key()
        • WrappingCollector
          • WrappingCollector.all_ids()
          • WrappingCollector.collect()
          • WrappingCollector.collect_matches()
          • WrappingCollector.count()
          • WrappingCollector.finish()
          • WrappingCollector.matches()
          • WrappingCollector.prepare()
          • WrappingCollector.remove()
          • WrappingCollector.results()
          • WrappingCollector.set_subsearcher()
          • WrappingCollector.sort_key()
      • Basic collectors
        • TopCollector
        • UnlimitedCollector
        • SortingCollector
      • Wrappers
        • FilterCollector
        • FacetCollector
        • CollapseCollector
        • TimeLimitCollector
        • TermsCollector
    • columns module
      • Base classes
        • Column
          • Column.default_value()
          • Column.reader()
          • Column.stores_lists()
          • Column.writer()
        • ColumnWriter
        • ColumnReader
      • Basic columns
        • VarBytesColumn
        • FixedBytesColumn
        • RefBytesColumn
        • NumericColumn
      • Technical columns
        • BitColumn
        • CompressedBytesColumn
        • StructColumn
        • PickleColumn
      • Experimental columns
        • ClampedNumericColumn
    • fields module
      • Schema class
        • Schema
          • Schema.add()
          • Schema.copy()
          • Schema.items()
          • Schema.names()
          • Schema.scorable_names()
          • Schema.stored_names()
        • SchemaClass
      • FieldType base class
        • FieldType
          • FieldType.clean()
          • FieldType.index()
          • FieldType.parse_query()
          • FieldType.parse_range()
          • FieldType.process_text()
          • FieldType.self_parsing()
          • FieldType.separate_spelling()
          • FieldType.sortable_terms()
          • FieldType.spellable_words()
          • FieldType.spelling_fieldname()
          • FieldType.subfields()
          • FieldType.supports()
          • FieldType.to_bytes()
          • FieldType.to_column_value()
          • FieldType.tokenize()
      • Pre-made field types
        • ID
        • IDLIST
        • STORED
        • KEYWORD
        • TEXT
        • NUMERIC
        • DATETIME
        • BOOLEAN
        • NGRAM
        • NGRAMWORDS
      • Exceptions
        • FieldConfigurationError
        • UnknownFieldError
    • filedb.filestore module
      • Base class
        • Storage
          • Storage.close()
          • Storage.create()
          • Storage.create_file()
          • Storage.create_index()
          • Storage.delete_file()
          • Storage.destroy()
          • Storage.file_exists()
          • Storage.file_length()
          • Storage.file_modified()
          • Storage.index_exists()
          • Storage.list()
          • Storage.lock()
          • Storage.open_file()
          • Storage.open_index()
          • Storage.optimize()
          • Storage.rename_file()
          • Storage.temp_storage()
      • Implementation classes
        • FileStorage
        • RamStorage
      • Helper functions
        • copy_storage()
        • copy_to_ram()
      • Exceptions
        • ReadOnlyError
    • filedb.filetables module
      • Hash file
        • HashWriter
          • HashWriter.add()
          • HashWriter.add_all()
        • HashReader
          • HashReader.all()
          • HashReader.open()
          • HashReader.ranges_for_key()
      • Ordered Hash file
        • OrderedHashWriter
        • OrderedHashReader
    • filedb.structfile module
      • Classes
        • StructFile
          • StructFile.close()
          • StructFile.flush()
          • StructFile.read_pickle()
          • StructFile.read_string()
          • StructFile.read_svarint()
          • StructFile.read_tagint()
          • StructFile.read_varint()
          • StructFile.write_byte()
          • StructFile.write_pickle()
          • StructFile.write_string()
          • StructFile.write_svarint()
          • StructFile.write_tagint()
          • StructFile.write_varint()
        • BufferFile
        • ChecksumFile
    • formats module
      • Base class
        • Format
          • Format.decode_as()
          • Format.decoder()
          • Format.supports()
          • Format.word_values()
      • Formats
        • Existence
        • Frequency
        • Positions
        • Characters
        • PositionBoosts
        • CharacterBoosts
    • highlight module
      • Manual highlighting
        • Highlighter
        • highlight()
      • Fragmenters
        • Fragmenter
          • Fragmenter.fragment_matches()
          • Fragmenter.fragment_tokens()
          • Fragmenter.must_retokenize()
        • WholeFragmenter
        • SentenceFragmenter
        • ContextFragmenter
        • PinpointFragmenter
      • Scorers
        • FragmentScorer
        • BasicFragmentScorer
      • Formatters
        • UppercaseFormatter
        • HtmlFormatter
        • GenshiFormatter
      • Utility classes
        • Fragment
    • support.bitvector module
      • Base classes
        • DocIdSet
          • DocIdSet.after()
          • DocIdSet.before()
          • DocIdSet.first()
          • DocIdSet.invert_update()
          • DocIdSet.last()
        • BaseBitSet
      • Implementation classes
        • BitSet
        • OnDiskBitSet
        • SortedIntSet
        • MultiIdSet
    • index module
      • Functions
        • create_in()
        • open_dir()
        • exists_in()
        • exists()
        • version_in()
        • version()
      • Base class
        • Index
          • Index.add_field()
          • Index.close()
          • Index.doc_count()
          • Index.doc_count_all()
          • Index.field_length()
          • Index.is_empty()
          • Index.last_modified()
          • Index.latest_generation()
          • Index.max_field_length()
          • Index.optimize()
          • Index.reader()
          • Index.refresh()
          • Index.remove_field()
          • Index.searcher()
          • Index.up_to_date()
          • Index.writer()
      • Implementation
        • FileIndex
      • Exceptions
        • LockError
        • IndexError
        • IndexVersionError
        • OutOfDateError
        • EmptyIndexError
    • lang.morph_en module
      • variations()
    • lang.porter module
      • stem()
    • lang.wordnet module
      • Thesaurus
        • Thesaurus
          • Thesaurus.from_file()
          • Thesaurus.from_filename()
          • Thesaurus.from_storage()
          • Thesaurus.synonyms()
          • Thesaurus.to_storage()
      • Low-level functions
        • parse_file()
        • synonyms()
        • make_index()
    • matching module
      • Matchers
        • Matcher
          • Matcher.all_ids()
          • Matcher.all_items()
          • Matcher.block_quality()
          • Matcher.children()
          • Matcher.copy()
          • Matcher.depth()
          • Matcher.id()
          • Matcher.is_active()
          • Matcher.items_as()
          • Matcher.matching_terms()
          • Matcher.max_quality()
          • Matcher.next()
          • Matcher.replace()
          • Matcher.reset()
          • Matcher.score()
          • Matcher.skip_to()
          • Matcher.skip_to_quality()
          • Matcher.spans()
          • Matcher.supports()
          • Matcher.supports_block_quality()
          • Matcher.term()
          • Matcher.term_matchers()
          • Matcher.value()
          • Matcher.value_as()
          • Matcher.weight()
        • NullMatcher
        • ListMatcher
        • WrappingMatcher
        • MultiMatcher
        • FilterMatcher
        • BiMatcher
        • AdditiveBiMatcher
        • UnionMatcher
        • DisjunctionMaxMatcher
        • IntersectionMatcher
        • AndNotMatcher
        • InverseMatcher
        • RequireMatcher
        • AndMaybeMatcher
        • ConstantScoreMatcher
      • Exceptions
        • ReadTooFar
        • NoQualityAvailable
    • qparser module
      • Parser object
        • QueryParser
          • QueryParser.add_plugin()
          • QueryParser.add_plugins()
          • QueryParser.default_set()
          • QueryParser.filterize()
          • QueryParser.filters()
          • QueryParser.multitoken_query()
          • QueryParser.parse()
          • QueryParser.process()
          • QueryParser.remove_plugin()
          • QueryParser.remove_plugin_class()
          • QueryParser.replace_plugin()
          • QueryParser.tag()
          • QueryParser.taggers()
          • QueryParser.term_query()
        • Pre-made configurations
          • MultifieldParser()
          • SimpleParser()
          • DisMaxParser()
      • Plug-ins
        • Plugin
          • Plugin.filters()
          • Plugin.taggers()
        • SingleQuotePlugin
        • PrefixPlugin
        • WildcardPlugin
        • RegexPlugin
        • BoostPlugin
        • GroupPlugin
        • EveryPlugin
        • FieldsPlugin
        • PhrasePlugin
        • RangePlugin
        • OperatorsPlugin
        • PlusMinusPlugin
        • GtLtPlugin
        • MultifieldPlugin
        • FieldAliasPlugin
        • CopyFieldPlugin
      • Syntax node objects
        • Base nodes
          • SyntaxNode
        • Nodes
          • FieldnameNode
          • TextNode
          • WordNode
          • RangeNode
          • MarkerNode
        • Group nodes
          • GroupNode
          • BinaryGroup
          • ErrorNode
          • AndGroup
          • OrGroup
          • AndNotGroup
          • AndMaybeGroup
          • DisMaxGroup
          • RequireGroup
          • NotGroup
        • Operators
          • Operator
          • PrefixOperator
          • PostfixOperator
          • InfixOperator
    • query module
      • Base classes
        • Query
          • Query.accept()
          • Query.all_terms()
          • Query.all_tokens()
          • Query.apply()
          • Query.children()
          • Query.copy()
          • Query.deletion_docs()
          • Query.docs()
          • Query.estimate_min_size()
          • Query.estimate_size()
          • Query.existing_terms()
          • Query.field()
          • Query.has_terms()
          • Query.is_leaf()
          • Query.is_range()
          • Query.iter_all_terms()
          • Query.leaves()
          • Query.matcher()
          • Query.normalize()
          • Query.replace()
          • Query.requires()
          • Query.simplify()
          • Query.terms()
          • Query.tokens()
          • Query.with_boost()
        • CompoundQuery
        • MultiTerm
        • ExpandingTerm
        • WrappingQuery
      • Query classes
        • Term
        • Variations
        • FuzzyTerm
        • Phrase
        • And
        • Or
        • DisjunctionMax
        • Not
        • Prefix
        • Wildcard
        • Regex
        • TermRange
        • NumericRange
        • DateRange
        • Every
        • NullQuery
      • Binary queries
        • Require
        • AndMaybe
        • AndNot
        • Otherwise
      • Span queries
        • Span
          • Span.merge()
        • SpanQuery
        • SpanFirst
        • SpanNear
        • SpanNear2
        • SpanNot
        • SpanOr
        • SpanContains
        • SpanBefore
        • SpanCondition
      • Special queries
        • NestedParent
        • NestedChildren
        • ConstantScoreQuery
      • Exceptions
        • QueryError
    • reading module
      • Classes
        • IndexReader
          • IndexReader.all_doc_ids()
          • IndexReader.all_stored_fields()
          • IndexReader.all_terms()
          • IndexReader.close()
          • IndexReader.codec()
          • IndexReader.column_reader()
          • IndexReader.corrector()
          • IndexReader.doc_count()
          • IndexReader.doc_count_all()
          • IndexReader.doc_field_length()
          • IndexReader.doc_frequency()
          • IndexReader.expand_prefix()
          • IndexReader.field_length()
          • IndexReader.field_terms()
          • IndexReader.first_id()
          • IndexReader.frequency()
          • IndexReader.generation()
          • IndexReader.has_deletions()
          • IndexReader.has_vector()
          • IndexReader.indexed_field_names()
          • IndexReader.is_deleted()
          • IndexReader.iter_docs()
          • IndexReader.iter_field()
          • IndexReader.iter_from()
          • IndexReader.iter_postings()
          • IndexReader.iter_prefix()
          • IndexReader.leaf_readers()
          • IndexReader.lexicon()
          • IndexReader.max_field_length()
          • IndexReader.min_field_length()
          • IndexReader.most_distinctive_terms()
          • IndexReader.most_frequent_terms()
          • IndexReader.postings()
          • IndexReader.segment()
          • IndexReader.storage()
          • IndexReader.stored_fields()
          • IndexReader.term_info()
          • IndexReader.terms_from()
          • IndexReader.terms_within()
          • IndexReader.vector()
          • IndexReader.vector_as()
        • MultiReader
        • TermInfo
          • TermInfo.doc_frequency()
          • TermInfo.max_id()
          • TermInfo.max_length()
          • TermInfo.max_weight()
          • TermInfo.min_id()
          • TermInfo.min_length()
          • TermInfo.weight()
      • Exceptions
        • TermNotFound
    • scoring module
      • Base classes
        • WeightingModel
          • WeightingModel.final()
          • WeightingModel.idf()
          • WeightingModel.scorer()
        • BaseScorer
          • BaseScorer.block_quality()
          • BaseScorer.max_quality()
          • BaseScorer.score()
          • BaseScorer.supports_block_quality()
        • WeightScorer
        • WeightLengthScorer
      • Scoring algorithm classes
        • BM25F
        • TF_IDF
        • Frequency
      • Scoring utility classes
        • FunctionWeighting
        • MultiWeighting
        • ReverseWeighting
    • searching module
      • Searching classes
        • Searcher
          • Searcher.boolean_context()
          • Searcher.collector()
          • Searcher.context()
          • Searcher.correct_query()
          • Searcher.doc_count()
          • Searcher.doc_count_all()
          • Searcher.docs_for_query()
          • Searcher.document()
          • Searcher.document_number()
          • Searcher.document_numbers()
          • Searcher.documents()
          • Searcher.get_parent()
          • Searcher.idf()
          • Searcher.key_terms()
          • Searcher.key_terms_from_text()
          • Searcher.more_like()
          • Searcher.postings()
          • Searcher.reader()
          • Searcher.refresh()
          • Searcher.search()
          • Searcher.search_page()
          • Searcher.search_with_collector()
          • Searcher.suggest()
          • Searcher.up_to_date()
      • Results classes
        • Results
          • Results.copy()
          • Results.docnum()
          • Results.docs()
          • Results.estimated_length()
          • Results.estimated_min_length()
          • Results.extend()
          • Results.facet_names()
          • Results.fields()
          • Results.filter()
          • Results.groups()
          • Results.has_exact_length()
          • Results.has_matched_terms()
          • Results.is_empty()
          • Results.items()
          • Results.key_terms()
          • Results.matched_terms()
          • Results.score()
          • Results.scored_length()
          • Results.upgrade()
          • Results.upgrade_and_extend()
        • Hit
          • Hit.fields()
          • Hit.highlights()
          • Hit.matched_terms()
          • Hit.more_like_this()
        • ResultsPage
          • ResultsPage.docnum()
          • ResultsPage.is_last_page()
          • ResultsPage.score()
      • Exceptions
        • NoTermsException
        • TimeLimit
    • sorting module
      • Base types
        • FacetType
          • FacetType.categorizer()
        • Categorizer
          • Categorizer.key_for()
          • Categorizer.key_to_name()
          • Categorizer.keys_for()
          • Categorizer.set_searcher()
      • Facet types
        • FieldFacet
        • QueryFacet
        • RangeFacet
        • DateRangeFacet
        • ScoreFacet
        • FunctionFacet
        • MultiFacet
        • StoredFieldFacet
      • Facets object
        • Facets
          • Facets.add_facet()
          • Facets.add_facets()
          • Facets.add_field()
          • Facets.add_query()
          • Facets.items()
          • Facets.names()
      • FacetType objects
        • FacetMap
          • FacetMap.add()
          • FacetMap.as_dict()
        • OrderedList
        • UnorderedList
        • Count
        • Best
    • spelling module
      • Corrector objects
        • Corrector
          • Corrector.suggest()
        • ReaderCorrector
        • MultiCorrector
      • QueryCorrector objects
        • QueryCorrector
          • QueryCorrector.correct_query()
        • SimpleQueryCorrector
        • Correction
    • support.charset module
      • default_charset
      • charset_table_to_dict()
    • support.levenshtein module
      • relative()
      • distance()
    • util module
      • fib()
      • make_binary_tree()
      • make_weighted_tree()
      • synchronized()
      • unclosed()
    • writing module
      • Writer
        • IndexWriter
          • IndexWriter.add_document()
          • IndexWriter.add_field()
          • IndexWriter.cancel()
          • IndexWriter.commit()
          • IndexWriter.delete_by_query()
          • IndexWriter.delete_by_term()
          • IndexWriter.delete_document()
          • IndexWriter.end_group()
          • IndexWriter.group()
          • IndexWriter.reader()
          • IndexWriter.remove_field()
          • IndexWriter.start_group()
          • IndexWriter.update_document()
      • Utility writers
        • BufferedWriter
          • BufferedWriter.add_document()
          • BufferedWriter.commit()
          • BufferedWriter.delete_document()
          • BufferedWriter.reader()
          • BufferedWriter.update_document()
        • AsyncWriter
          • AsyncWriter.add_document()
          • AsyncWriter.add_field()
          • AsyncWriter.cancel()
          • AsyncWriter.commit()
          • AsyncWriter.delete_by_term()
          • AsyncWriter.delete_document()
          • AsyncWriter.reader()
          • AsyncWriter.remove_field()
          • AsyncWriter.run()
          • AsyncWriter.update_document()
      • Exceptions
        • IndexingError
  • Technical notes
    • How to implement a new backend
      • Index
      • IndexWriter
      • IndexReader
      • Matcher
    • filedb notes
      • Files created

Release notes¶

  • Whoosh 2.x release notes
    • Whoosh 2.7
    • Whoosh 2.5
    • Whoosh 2.4
    • Whoosh 2.3.2
    • Whoosh 2.3.1
    • Whoosh 2.3
    • Whoosh 2.2
    • Whoosh 2.1
    • Whoosh 2.0
  • Whoosh 1.x release notes
    • Whoosh 1.8.3
    • Whoosh 1.8.2
    • Whoosh 1.8.1
    • Whoosh 1.8
    • Whoosh 1.7.7
    • Whoosh 1.7
    • Whoosh 1.6
    • Whoosh 1.5
    • Whoosh 1.3
    • Whoosh 1.2
    • Whoosh 1.0
    • User API changes
    • Misc
  • Whoosh 0.3 release notes
© Copyright 2007-2012 Matt Chaput. Built with Sphinx 5.3.0 and the Sizzle theme.