Enum elasticsearch_dsl::search::queries::Query[−][src]

pub enum Query {
Show 38 variants
    Bool(BoolQuery),
    Prefix(PrefixQuery),
    Regexp(RegexpQuery),
    Wildcard(WildcardQuery),
    TermsSet(TermsSetQuery),
    Term(TermQuery),
    TermsValues(TermsQuery<BTreeSet<Scalar>>),
    TermsLookup(TermsQuery<TermsLookup>),
    Exists(ExistsQuery),
    Range(RangeQuery),
    Ids(IdsQuery),
    ConstantScore(ConstantScoreQuery),
    DistanceFeatureDate(DistanceFeatureQuery<DateTime<Utc>>),
    DistanceFeatureGeo(DistanceFeatureQuery<GeoPoint>),
    Match(MatchQuery),
    MatchBoolPrefix(MatchBoolPrefixQuery),
    MatchPhrasePrefix(MatchPhrasePrefixQuery),
    MatchAll(MatchAllQuery),
    MatchNone(MatchNoneQuery),
    MatchPhrase(MatchPhraseQuery),
    MultiMatch(MultiMatchQuery),
    Nested(NestedQuery),
    Boosting(BoostingQuery),
    DisMax(DisMaxQuery),
    PercolateDocument(PercolateQuery<Value>),
    PercolateDocuments(PercolateQuery<Vec<Value>>),
    PercolateLookup(PercolateQuery<PercolateLookup>),
    FunctionScore(FunctionScoreQuery),
    RankFeature(RankFeatureQuery),
    RankFeatureSaturation(RankFeatureSaturationQuery),
    RankFeatureLogarithm(RankFeatureLogarithmQuery),
    RankFeatureSigmoid(RankFeatureSigmoidQuery),
    RankFeatureLinear(RankFeatureLinearQuery),
    MoreLikeThis(MoreLikeThisQuery),
    Fuzzy(FuzzyQuery),
    GeoDistance(GeoDistanceQuery),
    GeoBoundingBox(GeoBoundingBoxQuery),
    Json(JsonQuery),
}

Expand description

A container enum for supported Elasticsearch query types

Variants

`Bool(BoolQuery)`

Tuple Fields

0: BoolQuery

`Prefix(PrefixQuery)`

Tuple Fields

0: PrefixQuery

`Regexp(RegexpQuery)`

Tuple Fields

0: RegexpQuery

`Wildcard(WildcardQuery)`

Tuple Fields

0: WildcardQuery

`TermsSet(TermsSetQuery)`

Tuple Fields

0: TermsSetQuery

`Term(TermQuery)`

Tuple Fields

0: TermQuery

`TermsValues(TermsQuery<BTreeSet<Scalar>>)`

Tuple Fields

0: TermsQuery<BTreeSet<Scalar>>

`TermsLookup(TermsQuery<TermsLookup>)`

Tuple Fields

0: TermsQuery<TermsLookup>

`Exists(ExistsQuery)`

Tuple Fields

0: ExistsQuery

`Range(RangeQuery)`

Tuple Fields

0: RangeQuery

`Ids(IdsQuery)`

Tuple Fields

0: IdsQuery

`ConstantScore(ConstantScoreQuery)`

Tuple Fields

0: ConstantScoreQuery

`DistanceFeatureDate(DistanceFeatureQuery<DateTime<Utc>>)`

Tuple Fields

0: DistanceFeatureQuery<DateTime<Utc>>

`DistanceFeatureGeo(DistanceFeatureQuery<GeoPoint>)`

Tuple Fields

0: DistanceFeatureQuery<GeoPoint>

`Match(MatchQuery)`

Tuple Fields

0: MatchQuery

`MatchBoolPrefix(MatchBoolPrefixQuery)`

Tuple Fields

0: MatchBoolPrefixQuery

`MatchPhrasePrefix(MatchPhrasePrefixQuery)`

Tuple Fields

0: MatchPhrasePrefixQuery

`MatchAll(MatchAllQuery)`

Tuple Fields

0: MatchAllQuery

`MatchNone(MatchNoneQuery)`

Tuple Fields

0: MatchNoneQuery

`MatchPhrase(MatchPhraseQuery)`

Tuple Fields

0: MatchPhraseQuery

`MultiMatch(MultiMatchQuery)`

Tuple Fields

0: MultiMatchQuery

`Nested(NestedQuery)`

Tuple Fields

0: NestedQuery

`Boosting(BoostingQuery)`

Tuple Fields

0: BoostingQuery

`DisMax(DisMaxQuery)`

Tuple Fields

0: DisMaxQuery

`PercolateDocument(PercolateQuery<Value>)`

Tuple Fields

0: PercolateQuery<Value>

`PercolateDocuments(PercolateQuery<Vec<Value>>)`

Tuple Fields

0: PercolateQuery<Vec<Value>>

`PercolateLookup(PercolateQuery<PercolateLookup>)`

Tuple Fields

0: PercolateQuery<PercolateLookup>

`FunctionScore(FunctionScoreQuery)`

Tuple Fields

0: FunctionScoreQuery

`RankFeature(RankFeatureQuery)`

Tuple Fields

0: RankFeatureQuery

`RankFeatureSaturation(RankFeatureSaturationQuery)`

Tuple Fields

0: RankFeatureSaturationQuery

`RankFeatureLogarithm(RankFeatureLogarithmQuery)`

Tuple Fields

0: RankFeatureLogarithmQuery

`RankFeatureSigmoid(RankFeatureSigmoidQuery)`

Tuple Fields

0: RankFeatureSigmoidQuery

`RankFeatureLinear(RankFeatureLinearQuery)`

Tuple Fields

0: RankFeatureLinearQuery

`MoreLikeThis(MoreLikeThisQuery)`

Tuple Fields

0: MoreLikeThisQuery

`Fuzzy(FuzzyQuery)`

Tuple Fields

0: FuzzyQuery

`GeoDistance(GeoDistanceQuery)`

Tuple Fields

0: GeoDistanceQuery

`GeoBoundingBox(GeoBoundingBoxQuery)`

Tuple Fields

0: GeoBoundingBoxQuery

`Json(JsonQuery)`

Tuple Fields

0: JsonQuery

Implementations

[src]

impl Query

[src]

pub fn bool() -> BoolQuery

Creates an instance of BoolQuery

[src]

impl Query

[src]

pub fn boosting<Q, B>(
 positive: Q,
 negative: Q,
 negative_boost: B
) -> BoostingQuery where
 Q: Into<Query>,
 B: Into<NegativeBoost>,

Creates an instance of BoostingQuery

positive - Query you wish to run. Any returned documents must match this query.
negative - Query used to decrease the relevance score of matching documents.
If a returned document matches the positive query and this query, the boosting query calculates the final relevance score for the document as follows:
1. Take the original relevance score from the positive query.
2. Multiply the score by the negative_boost value.
negative_boost - Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the negative query.

[src]

impl Query

[src]

pub fn constant_score(filter: impl Into<Query>) -> ConstantScoreQuery

Creates an instance of ConstantScoreQuery

filter - Filter query you wish to run. Any returned documents must match this query.
Filter queries do not calculate relevance scores. To speed up performance, Elasticsearch automatically caches frequently used filter queries.

[src]

impl Query

[src]

pub fn dis_max() -> DisMaxQuery

Creates an instance of DisMaxQuery

[src]

impl Query

[src]

pub fn function_score(query: impl Into<Query>) -> FunctionScoreQuery

Creates an instance of FunctionScoreQuery

[src]

impl Query

[src]

pub fn json(query: Value) -> JsonQuery

Creates an instance of JsonQuery

query - raw JSON query

[src]

impl Query

[src]

pub fn combined_fields<F, S>(fields: F, query: S) -> CombinedFieldsQuery where
 F: IntoIterator,
 F::Item: ToString,
 S: Into<String>,

Creates an instance of CombinedFieldsQuery

fields - List of fields to search. Field wildcard patterns are allowed. Only text fields are supported, and they must all have the same search analyzer.
query - Text to search for in the provided <fields>. The combined_fields query analyzes the provided text before performing a search.

[src]

impl Query

[src]

pub fn match_bool_prefix(
field: impl Into<String>,
query: impl Into<String>
) -> MatchBoolPrefixQuery

Creates an instance of MatchBoolPrefixQuery

field - Field you wish to search.
query - Text, number, boolean value or date you wish to find in the provided <field>

[src]

impl Query

[src]

pub fn match_phrase_prefix(
field: impl Into<String>,
query: impl Into<String>
) -> MatchPhrasePrefixQuery

Creates an instance of MatchPhrasePrefixQuery

field - Field you wish to search.
query - Text you wish to find in the provided .
The match_phrase_prefix query analyzes any provided text into tokens before performing a search. The last term of this text is treated as a prefix, matching any words that begin with that term.

[src]

impl Query

[src]

pub fn match_phrase(
field: impl Into<String>,
query: impl Into<String>
) -> MatchPhraseQuery

Creates an instance of MatchPhraseQuery

field - Field you wish to search.
query - Text, number, boolean value or date you wish to find in the provided <field>.
The match_phrase query analyzes any provided text before performing a search. This means the match_phrase query can search text fields for analyzed tokens rather than an exact term.

[src]

impl Query

[src]

pub fn match(field: impl Into<String>, query: impl Into<String>) -> MatchQuery

Creates an instance of MatchQuery

field - Field you wish to search.
query - Text, number, boolean value or date you wish to find in the provided <field>.
The match query analyzes any provided text before performing a search. This means the match query can search text fields for analyzed tokens rather than an exact term.

[src]

impl Query

[src]

pub fn multi_match<F, S>(fields: F, query: S) -> MultiMatchQuery where
 F: IntoIterator,
 F::Item: ToString,
 S: Into<String>,

Creates an instance of MultiMatchQuery

fields - Fields you wish to search.
query - Text, number, boolean value or date you wish to find in the provided <field>. The match query analyzes any provided text before performing a search. This means the match query can search text fields for analyzed tokens rather than an exact term.

[src]

impl Query

[src]

pub fn query_string<S>(query: S) -> QueryStringQuery where
S: Into<String>,

Creates an instance of QueryStringQuery

query - Query string you wish to parse and use for search. See Simple query string syntax.

[src]

impl Query

[src]

pub fn simple_query_string<S>(query: S) -> SimpleQueryStringQuery where
S: Into<String>,

Creates an instance of SimpleQueryStringQuery

query - Query string you wish to parse and use for search. See Simple query string syntax.

[src]

impl Query

[src]

pub fn geo_bounding_box(
field: impl Into<String>,
value: impl Into<GeoBoundingBox>
) -> GeoBoundingBoxQuery

Creates an instance of GeoBoundingBoxQuery

field - Field you wish to search.
value - A series of vertex coordinates of a geo bounding box

[src]

impl Query

[src]

pub fn geo_distance(
 field: impl Into<String>,
 origin: impl Into<GeoPoint>,
 distance: impl Into<Distance>
) -> GeoDistanceQuery

Creates an instance of GeoDistanceQuery

field - Field you wish to search
origin - GeoPoint to measure distance to
distance - Distance threshold

[src]

impl Query

[src]

pub fn has_child(type: impl ToString, query: impl Into<Query>) -> HasChildQuery

Creates an instance of HasChildQuery

type - Name of the child relationship mapped for the join field.
query - Query you wish to run on child documents of the type field. If a child document matches the search, the query returns the parent document.

[src]

impl Query

[src]

pub fn has_parent(
parent_type: impl ToString,
query: impl Into<Query>
) -> HasParentQuery

Creates an instance of HasParentQuery

parent-type - Name of the parent relationship mapped for the join field.
query - Query you wish to run on parent documents of the parent_type field. If a parent document matches the search, the query returns its child documents.

[src]

impl Query

[src]

pub fn nested(path: impl Into<String>, query: impl Into<Query>) -> NestedQuery

Creates an instance of NestedQuery

path - Path to the nested object you wish to search.
query - Query you wish to run on nested objects in the path. If an object matches the search, the nested query returns the root parent document.
You can search nested fields using dot notation that includes the complete path, such as obj1.name.
Multi-level nesting is automatically supported, and detected, resulting in an inner nested query to automatically match the relevant nesting level, rather than root, if it exists within another nested query.
Multi-level nested queries are also supported.

[src]

impl Query

[src]

pub fn parent_id(type: impl ToString, id: impl ToString) -> ParentIdQuery

Creates an instance of ParentIdQuery

type - Name of the child relationship mapped for the join field
id - ID of the parent document. The query will return child documents of this parent document.

[src]

impl Query

[src]

pub fn distance_feature<O: Origin>(
 field: impl Into<String>,
 origin: O,
 pivot: <O as Origin>::Pivot
) -> DistanceFeatureQuery<O>

Creates an instance of DistanceFeatureQuery

field - Name of the field used to calculate distances. This field must meet the following criteria:
- Be a date, date_nanos or geo_point field
- Have an index mapping parameter value of true, which is the default
- Have an doc_values mapping parameter value of true, which is the default
origin - Date or point of origin used to calculate distances.
If the field value is a date or date_nanos field, the origin value must be a date. Date Math, such as now-1h, is supported.
If the field value is a geo_point field, the origin value must be a geopoint.
pivot - Distance from the origin at which relevance scores receive half of the boost value.
If the field value is a date or date_nanos field, the pivot value must be a time unit , such as 1h or 10d.
If the field value is a geo_point field, the pivot value must be a distance unit , such as 1km or 12m.

[src]

impl Query

[src]

pub fn more_like_this(like: I) -> MoreLikeThisQuery where
I: IntoIterator,
I::Item: Into<Like>,

Creates an instance of MoreLikeThisQuery

like - free form text and/or a single or multiple documents.

[src]

impl Query

[src]

pub fn percolate<T: PercolateMarker>(
field: impl Into<String>,
source: T
) -> PercolateQuery<T>

Creates an instance of PercolateQuery

field - The field of type percolator that holds the indexed queries
source - Source to percolate

[src]

pub fn percolate_lookup<S>(
 field: S,
 index: S,
 id: S
) -> PercolateQuery<PercolateLookup> where
 S: Into<String>,

Creates an instance of PercolateQuery

field - The field of type percolator that holds the indexed queries
index - The index the document resides in
id - The id of the document to fetch

[src]

impl Query

[src]

pub fn rank_feature(field: impl Into<String>) -> RankFeatureQuery

Creates an instance of RankFeatureQuery

field - rank_feature or rank_features field used to boost relevance scores

[src]

impl Query

[src]

pub fn exists(field: impl Into<String>) -> ExistsQuery

Creates an instance of ExistsQuery

field - Name of the field you wish to search. While a field is deemed non-existent if the JSON value is null or [], these values will indicate the field does exist:
- Empty strings, such as "" or "-"
- Arrays containing null and another value, such as [null, "foo"]
- A custom null-value, defined in field mapping

[src]

impl Query

[src]

pub fn fuzzy(
field: impl Into<String>,
value: impl Into<OptionalScalar>
) -> FuzzyQuery

Creates an instance of FuzzyQuery

field - Field you wish to search.
value - Fuzzy you wish to find in the provided field.

[src]

impl Query

[src]

pub fn ids(values: I) -> IdsQuery where
I: IntoIterator,
I::Item: ToString,

Creates an instance of IdsQuery

values - An array of document IDs.

[src]

impl Query

[src]

pub fn prefix(
field: impl Into<String>,
value: impl Into<OptionalScalar>
) -> PrefixQuery

Creates an instance of PrefixQuery

field - Field you wish to search.
value - Term you wish to find in the provided field. To return a document, the term must exactly match the field value, including whitespace and capitalization.

[src]

impl Query

[src]

pub fn range(field: impl Into<String>) -> RangeQuery

Creates an instance of RangeQuery

field - Field you wish to search.

[src]

impl Query

[src]

pub fn regexp<S>(field: S, value: S) -> RegexpQuery where
S: Into<String>,

Creates an instance of RegexpQuery

field - Field you wish to search.
value - Regular expression for terms you wish to find in the provided field. For a list of supported operators, see Regular expression syntax.

By default, regular expressions are limited to 1,000 characters. You can change this limit using the index.max_regex_length setting.

[src]

impl Query

[src]

pub fn term(
field: impl Into<String>,
value: impl Into<OptionalScalar>
) -> TermQuery

Creates an instance of TermQuery

field - Field you wish to search.
value - Term you wish to find in the provided field. To return a document, the term must exactly match the field value, including whitespace and capitalization.

[src]

impl Query

[src]

pub fn terms<S, I>(field: S, values: I) -> TermsQuery<BTreeSet<Scalar>> where
 S: Into<String>,
 I: IntoIterator,
 I::Item: Into<Scalar>,

Creates an instance of TermsQuery

field - Field you wish to search.
values - An array of terms you wish to find in the provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.
By default, Elasticsearch limits the terms query to a maximum of 65,536 terms. You can change this limit using the index.max_terms_count setting.

To use the field values of an existing document as search terms, use the terms lookup parameters.

[src]

pub fn terms_lookup<S: Into<String>>(
 field: S,
 index: S,
 id: S,
 path: S
) -> TermsQuery<TermsLookup>

Creates an instance of TermsQuery

field - Field you wish to search.
index - Name of the index from which to fetch field values.
id - ID of the document from which to fetch field values.
path - Name of the field from which to fetch field values. Elasticsearch uses these values as search terms for the query. If the field values include an array of nested inner objects, you can access those objects using dot notation syntax.

[src]

impl Query

[src]

pub fn terms_set(
 field: impl Into<String>,
 terms: I,
 minimum_should_match: impl Into<TermsSetMinimumShouldMatch>
) -> TermsSetQuery where
 I: IntoIterator,
 I::Item: Into<Scalar>,

Creates an instance of TermsSetQuery

field - Field you wish to search.
value - TermsSet you wish to find in the provided field. To return a document, the terms_set must exactly match the field value, including whitespace and capitalization.

[src]

impl Query

[src]

pub fn wildcard(
field: impl Into<String>,
value: impl Into<OptionalScalar>
) -> WildcardQuery

Creates an instance of WildcardQuery

field - Field you wish to search.
value - Wildcard you wish to find in the provided field. To return a document, the wildcard must exactly match the field value, including whitespace and capitalization.

[src]