Struct Search 

pub struct Search { /* private fields */ }

Returns search hits that match the query defined in the request.

https://www.elastic.co/guide/en/opensearch/reference/current/search-search.html

Implementations

impl Search

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Search

where N: Into<AggregationName>, A: Into<Aggregation>,

Pushes aggregation

pub fn new() -> Search

Creates a default search instance

pub fn runtime_mapping<S>(self, name: S, mapping: RuntimeMapping) -> Search

where S: ToString,

Add runtime mapping to the search request

pub fn script_fields<S, T>(self, name: S, script: T) -> Search

where S: ToString, T: Into<ScriptField>,

Add script fields to the search request

pub fn indices_boost<T, U>(self, field: T, boost: U) -> Search

where T: ToString, U: AsPrimitive<f32>,

Allows to configure different boost level per index when searching across more than one indices. This is very handy when hits coming from one index matter more than hits coming from another index (think social graph where each user has an index).

pub fn min_score<F>(self, min_score: F) -> Search

where F: Into<f32>,

Exclude documents which have a _score less than the minimum specified in min_score

Note, most times, this does not make much sense, but is provided for advanced use cases

pub fn source<S>(self, source: S) -> Search

where S: Into<SourceFilter>,

Indicates which source fields are returned for matching documents

pub fn stats<S>(self, stats: S) -> Search

where S: ToString,

Specific tag of the request for logging and statistical purposes.

pub fn from(self, from: u64) -> Search

Starting document offset.

Defaults to 0.

pub fn size(self, size: u64) -> Search

The number of hits to return.

Defaults to 10.

pub fn query<Q>(self, query: Q) -> Search

where Q: Into<Query>,

Defines the search definition using the Query DSL.

pub fn post_filter<Q>(self, post_filter: Q) -> Search

where Q: Into<Query>,

When you use the post_filter parameter to filter search results, the search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.

pub fn sort<T>(self, sort: T) -> Search

where T: IntoIterator, <T as IntoIterator>::Item: Into<Sort>,

A collection of sorting fields

pub fn track_total_hits<T>(self, track_total_hits: T) -> Search

where T: Into<TrackTotalHits>,

Track total hits

pub fn track_scores(self, enabled: bool) -> Search

If true, calculate and return document scores, even if the scores are not used for sorting.

pub fn highlight<H>(self, highlight: H) -> Search

where H: Into<Highlight>,

Highlight

pub fn rescore<T>(self, rescore: T) -> Search

where T: IntoIterator, <T as IntoIterator>::Item: Into<Rescore>,

Rescore

pub fn suggest<T, U>(self, name: T, suggester: U) -> Search

where T: ToString, U: Into<Suggester>,

Suggest

pub fn stored_fields<T>(self, stored_fields: T) -> Search

where T: Into<StoredFields>,

A collection of stored fields

pub fn docvalue_fields<T>(self, docvalue_fields: T) -> Search

where T: IntoIterator, <T as IntoIterator>::Item: ToString,

A collection of docvalue fields

pub fn pit(self, pit: PointInTime) -> Search

Point in time

pub fn search_after<T>(self, sort_values: T) -> Search

where T: Into<Terms>,

Search after a set of sort values.

pub fn timeout<T>(self, timeout: T) -> Search

where T: Into<Time>,

parameter to specify a duration you’d like to wait on each shard to complete.

https://www.elastic.co/guide/en/opensearch/reference/8.9/search-your-data.html#search-timeout

pub fn knn(self, knn: Knn) -> Search

Defines the kNN query to run.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-api-knn

pub fn collapse<C>(self, collapse: C) -> Search

where C: Into<Collapse>,

Parameter to specify collapsing results on some field

https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html

pub fn extra(self, extra: BTreeMap<String, Value>) -> Search

Extra fields for something not yet supported.

Search::new()
    .size(10)
    .extra([
        (
            "knn".to_owned(),
            json!({ "field": "abc" }),
        ),
        (
            "terminate_after".to_owned(),
            json!(42)
        ),
    ].into());

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Search

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Search

fn deserialize<__D>( __deserializer: __D, ) -> Result<Search, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Search

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Search

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Search