Struct elasticsearch_dsl::search::queries::full_text::MatchQuery

source · [−]

pub struct MatchQuery { /* private fields */ }

Expand description

Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

The match query is the standard query for performing a full-text search, including options for fuzzy matching.

To create a Match query:

Query::r#match("test", "search text")
    .boost(2)
    .name("test");

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html

Implementations

source

impl MatchQuery

source

pub fn analyzer(self, analyzer: impl Into<String>) -> Self

Analyzer used to convert the text in the query value into tokens. Defaults to the index-time analyzer mapped for the <field>. If no analyzer is mapped, the index’s default analyzer is used.

source

pub fn auto_generate_synonyms_phrase_query(
self,
auto_generate_synonyms_phrase_query: bool
) -> Self

If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.

See Use synonyms with match query for an example.

source

pub fn fuzziness(self, fuzziness: impl Into<Fuzziness>) -> Self

Maximum edit distance allowed for matching. See Fuzziness for valid values and more information. See Fuzziness in the match query for an example.

source

pub fn max_expansions(self, max_expansions: u8) -> Self

Maximum number of terms to which the query will expand. Defaults to 50.

source

pub fn prefix_length(self, prefix_length: u8) -> Self

Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

source

pub fn fuzzy_transpositions(self, fuzzy_transpositions: bool) -> Self

If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.

source

pub fn fuzzy_rewrite(self, fuzzy_rewrite: Rewrite) -> Self

Method used to rewrite the query. See the rewrite parameter for valid values and more information.

If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.

source

pub fn lenient(self, lenient: bool) -> Self

If true, format-based errors, such as providing a text query value for a numeric field, are ignored. Defaults to false.

source

pub fn operator(self, operator: Operator) -> Self

Boolean logic used to interpret text in the query value

source

pub fn minimum_should_match(
self,
minimum_should_match: impl Into<MinimumShouldMatch>
) -> Self

Minimum number of clauses that must match for a document to be returned. See the minimum_should_match parameter for valid values and more information.

source

pub fn zero_terms_query(self, zero_terms_query: ZeroTermsQuery) -> Self

Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a stop filter.

source

pub fn boost(self, boost: B) -> Self where
B: TryInto<Boost>,

Floating point number used to decrease or increase the relevance scores of a query. Defaults to 1.0.

You can use the boost parameter to adjust relevance scores for searches containing two or more queries.

Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.

source

pub fn name<S>(self, name: S) -> Self where
S: ToString,

You can use named queries to track which queries matched returned documents. If named queries are used, the response includes a matched_queries property for each hit.

https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html#named-queries