Struct elasticsearch_dsl::search::queries::term_level::TermsSetQuery

pub struct TermsSetQuery { /* private fields */ }

Returns documents that contain an exact terms_set in a provided field.

You can use the terms_set query to find documents based on a precise value such as a price, a product ID, or a username.

To create a terms_set query with numeric field:

Query::terms_set("test", [123], "required_matches");

To create a terms_set query with script:

Query::terms_set(
    "test",
    [123],
    TermsSetScript::new("Math.min(params.num_terms_sets, doc['required_matches'].value)")
        .params(serde_json::json!({"num_terms_sets": 2}))
);

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

Implementations

impl TermsSetQuery

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 TermsSetQuery

fn clone(&self) -> TermsSetQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TermsSetQuery

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

Formats the value using the given formatter.

impl From<TermsSetQuery> for Option<Query>

fn from(q: TermsSetQuery) -> Self

Converts to this type from the input type.

impl From<TermsSetQuery> for Query

fn from(q: TermsSetQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for TermsSetQuery

type Item = TermsSetQuery

The type of the elements being iterated over.

type IntoIter = IntoIter<<TermsSetQuery 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 TermsSetQuery

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

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

const 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<TermsSetQuery> for Query

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

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

const 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<TermsSetQuery> for TermsSetQuery

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

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

const 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 TermsSetQuery

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 TermsSetQuery