Struct elasticsearch_dsl::search::queries::specialized::PercolateQuery

pub struct PercolateQuery<T: PercolateMarker> { /* fields omitted */ }

The percolate query can be used to match queries stored in an index. The percolate query itself contains the document that will be used as query to match with the stored queries.

To percolate single document:

Query::percolate("field", json!({ "message": "search text" }));

To percolate multiple documents:

Query::percolate("field", vec![json!({ "message": "search text" }), json!({ "message": "another search text" })]);

To percolate indexed document:

Query::percolate("field", PercolateLookup::new("index_name", "document_id"));
Query::percolate_lookup("field", "index_name", "document_id");

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

Implementations

impl<T: PercolateMarker> PercolateQuery<T>

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

The suffix to be used for the _percolator_document_slot field in case multiple percolate queries have been specified. This is an optional parameter

impl PercolateQuery<PercolateLookup>

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

Routing to be used to fetch document to percolate

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

Preference to be used to fetch document to percolate

pub fn version(self, version: impl Into<i64>) -> Self

The expected version of the document to be fetched

Trait Implementations

impl<T: Clone + PercolateMarker> Clone for PercolateQuery<T>

fn clone(&self) -> PercolateQuery<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + PercolateMarker> Debug for PercolateQuery<T>

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

Formats the value using the given formatter.

impl From<PercolateQuery<PercolateLookup>> for Query

fn from(q: PercolateQuery<PercolateLookup>) -> Self

Performs the conversion.

impl From<PercolateQuery<PercolateLookup>> for Option<Query>

fn from(q: PercolateQuery<PercolateLookup>) -> Self

Performs the conversion.

impl From<PercolateQuery<Value>> for Query

fn from(q: PercolateQuery<Value>) -> Self

Performs the conversion.

impl From<PercolateQuery<Value>> for Option<Query>

fn from(q: PercolateQuery<Value>) -> Self

Performs the conversion.

impl From<PercolateQuery<Vec<Value, Global>>> for Query

fn from(q: PercolateQuery<Vec<Value>>) -> Self

Performs the conversion.

impl From<PercolateQuery<Vec<Value, Global>>> for Option<Query>

fn from(q: PercolateQuery<Vec<Value>>) -> Self

Performs the conversion.

impl<T: PartialEq + PercolateMarker> PartialEq<PercolateQuery<T>> for PercolateQuery<T>

fn eq(&self, other: &PercolateQuery<T>) -> bool

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

fn ne(&self, other: &PercolateQuery<T>) -> bool

This method tests for !=.

impl<T: PercolateMarker> Serialize for PercolateQuery<T>

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

Serialize this value into the given Serde serializer.

impl<T: PercolateMarker> StructuralPartialEq for PercolateQuery<T>