Struct elasticsearch_dsl::search::queries::full_text::SimpleQueryStringQuery

pub struct SimpleQueryStringQuery { /* private fields */ }

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 with numeric values:

Query::simple_query_string("\"fried eggs\" +(eggplant | potato) -frittata")
    .boost(2)
    .name("test");

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

Implementations

impl SimpleQueryStringQuery

pub fn fields<I>(self, fields: I) -> Selfwhere
    I: IntoIterator,
    I::Item: ToString,

Array of fields you wish to search.

This field accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (^) notation. See Wildcards and per-field boosts in the fields parameter for examples.

Defaults to the index.query.default_field index setting, which has a default value of *. The * value extracts all fields that are eligible to term queries and filters the metadata fields. All extracted fields are then combined to build a query if no prefix is specified.

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

Default boolean logic used to interpret text in the query string if no operators are specified.

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

If true, the query attempts to analyze wildcard terms in the query string.

Defaults to false.

pub fn analyzer<T>(self, analyzer: T) -> Selfwhere
    T: ToString,

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

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

If true, the parser creates a match_phrase query for each multi-position token.

Defaults to true. For examples, see Multi-position tokens.

pub fn flags<I>(self, flags: I) -> Selfwhere
    I: IntoIterator<Item = SimpleQueryStringQueryFlags>,

List of enabled operators for the simple query string syntax.

Defaults to ALL (all operators). See Limit operators for valid values.

pub fn fuzzy_max_expansions(self, fuzzy_max_expansions: u32) -> Self

Maximum number of terms to which the query expands for fuzzy matching.

Defaults to 50.

pub fn fuzzy_prefix_length(self, fuzzy_prefix_length: u32) -> Self

Number of beginning characters left unchanged for fuzzy matching.

Defaults to 0.

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.

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.

pub fn minimum_should_match<T>(self, minimum_should_match: T) -> Selfwhere
    T: ToString,

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.

pub fn quote_field_suffix<S>(self, quote_field_suffix: S) -> Selfwhere
    S: ToString,

Suffix appended to quoted text in the query string.

You can use this suffix to use a different analysis method for exact matches. See Mixing exact search with stemming.

pub fn boost<T>(self, boost: T) -> Selfwhere
    T: AsPrimitive<f32>,

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.

pub fn name<S>(self, name: S) -> Selfwhere
    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

Trait Implementations

impl Clone for SimpleQueryStringQuery

fn clone(&self) -> SimpleQueryStringQuery

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SimpleQueryStringQuery

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SimpleQueryStringQuery> for Option<Query>

fn from(q: SimpleQueryStringQuery) -> Self

Converts to this type from the input type.

impl From<SimpleQueryStringQuery> for Query

fn from(q: SimpleQueryStringQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for SimpleQueryStringQuery

type Item = SimpleQueryStringQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<SimpleQueryStringQuery as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Query> for SimpleQueryStringQuery

fn eq(&self, other: &Query) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<SimpleQueryStringQuery> for Query

fn eq(&self, other: &SimpleQueryStringQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<SimpleQueryStringQuery> for SimpleQueryStringQuery

fn eq(&self, other: &SimpleQueryStringQuery) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SimpleQueryStringQuery

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SimpleQueryStringQuery