Expand description
Module containing the different query implementations.
Structs§
- AllQuery
- Query that matches all of the documents.
- AllScorer
- Scorer associated with the
AllQueryquery. - AllWeight
- Weight associated with the
AllQueryquery. - Automaton
Weight - A weight struct for Fuzzy Term and Regex Queries
- BitSet
DocSet - A
BitSetDocSetmakes it possible to iterate through a bitset as if it was aDocSet. - Boolean
Query - The boolean query returns a set of documents that matches the Boolean combination of constituent subqueries.
- Boost
Query BoostQueryis a wrapper over a query used to boost its score.- Const
Score Query ConstScoreQueryis a wrapper over a query to provide a constant score. It can avoid unnecessary score computation on the wrapped query.- Const
Scorer - Wraps a
DocSetand simply returns a constantScorer. TheConstScoreris useful if you have aDocSetwhere you needed a scorer. - Disjunction
MaxCombiner - Take max score of different scorers
and optionally sum it with other matches multiplied by
tie_breaker - Disjunction
MaxQuery - The disjunction max query returns documents matching one or more wrapped queries, called query clauses or clauses.
- Empty
Query EmptyQueryis a dummyQueryin which no document matches.- Empty
Scorer EmptyScoreris a dummyScorerin which no document matches.- Empty
Weight EmptyWeightis a dummyWeightin which no document matches.- Exclude
- Filters a given
DocSetby removing the docs from a givenDocSet. - Explanation
- Object describing the score of a given document. It is organized in trees.
- Fuzzy
Term Query - A Fuzzy Query matches all of the documents containing a specific term that is within Levenshtein distance
- Intersection
- Creates a
DocSetthat iterate through the intersection of two or moreDocSets. - More
Like This Query - A query that matches all of the documents similar to a document or a set of field values provided.
- More
Like This Query Builder - The builder for more-like-this query
- Phrase
Query PhraseQuerymatches a specific sequence of words.- Query
Parser - Tantivy’s Query parser
- Range
Query RangeQuerymatches all documents that have at least one term within a defined range.- Regex
Query - A Regex Query matches all of the documents containing a specific term that matches a regex pattern.
- Required
Optional Scorer - Given a required scorer and an optional scorer matches all document from the required scorer and complements the score using the optional scorer.
- SumCombiner
- Sums the score of different scorers.
- SumWith
Coords Combiner - Sums the score of different scorers and keeps the count of scorers which matched.
- Term
Query - A Term query matches all of the documents containing a specific term.
- Term
SetQuery - A Term Set Query matches all of the documents containing any of the Term provided
- Union
- Creates a
DocSetthat iterate through the union of two or moreDocSets.
Enums§
- Enable
Scoring - Argument used in
Query::weight(..) - Occur
- Defines whether a term in a query must be present, should be present or must not be present.
- Query
Parser Error - Possible error that may happen when parsing a query.
Traits§
- Query
- The
Querytrait defines a set of documents and a scoring method for those documents. - Query
Clone - Implements
box_clone. - Score
Combiner - The
ScoreCombinertrait defines how to compute an overall score given a list of scores. - Scorer
- Scored set of documents matching a query within a specific segment.
- Weight
- A Weight is the specialization of a
Queryfor a given set of segments.
Functions§
- intersect_
scorers - Returns the intersection scorer.