Struct elasticsearch_dsl::search::queries::term_level::TermsLookupQuery

pub struct TermsLookupQuery { /* private fields */ }

Terms lookup fetches the field values of an existing document. Elasticsearch then uses those values as search terms. This can be helpful when searching for a large set of terms.

Because terms lookup fetches values from a document, the _source mapping field must be enabled to use terms lookup. The _source field is enabled by default.

By default, Elasticsearch limits the terms query to a maximum of 65,536 terms. This includes terms fetched using terms lookup. You can change this limit using the index.max_terms_count setting.

To create a terms lookup query:

Query::terms_lookup("test", "index", "id", "path")
    .routing("routing")
    .boost(1.3)
    .name("lookup");

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

Implementations

impl TermsLookupQuery

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

impl TermsLookupQuery

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

Custom routing value of the document from which to fetch term values. If a custom routing value was provided when the document was indexed, this parameter is required.

Trait Implementations

impl Clone for TermsLookupQuery

fn clone(&self) -> TermsLookupQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TermsLookupQuery

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

Formats the value using the given formatter.

impl From<TermsLookupQuery> for Option<Query>

fn from(q: TermsLookupQuery) -> Self

Converts to this type from the input type.

impl From<TermsLookupQuery> for Query

fn from(q: TermsLookupQuery) -> Self

Converts to this type from the input type.

impl IntoIterator for TermsLookupQuery

type Item = TermsLookupQuery

The type of the elements being iterated over.

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

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<TermsLookupQuery> for Query

fn eq(&self, other: &TermsLookupQuery) -> 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<TermsLookupQuery> for TermsLookupQuery

fn eq(&self, other: &TermsLookupQuery) -> 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 TermsLookupQuery

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 TermsLookupQuery