Struct elasticsearch_dsl::search::request::Search

pub struct Search { /* private fields */ }

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

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

Implementations

impl Search

pub fn new() -> Self

Creates a default search instance

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

Add runtime mapping to the search request

pub fn script_fields<S, T>(self, name: S, script: T) -> Selfwhere S: ToString, T: Into<ScriptField>,

Add script fields to the search request

pub fn indices_boost<T, U>(self, field: T, boost: U) -> Selfwhere 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) -> Selfwhere 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) -> Selfwhere S: Into<SourceFilter>,

Indicates which source fields are returned for matching documents

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

Specific tag of the request for logging and statistical purposes.

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

Starting document offset.

Defaults to 0.

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

The number of hits to return.

Defaults to 10.

pub fn query<Q>(self, query: Q) -> Selfwhere Q: Into<Query>,

Defines the search definition using the Query DSL.

pub fn post_filter<Q>(self, post_filter: Q) -> Selfwhere 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) -> Selfwhere T: IntoIterator, T::Item: Into<Sort>,

A collection of sorting fields

pub fn track_total_hits<T>(self, track_total_hits: T) -> Selfwhere T: Into<TrackTotalHits>,

Track total hits

pub fn highlight<H>(self, highlight: H) -> Selfwhere H: Into<Highlight>,

Highlight

pub fn rescore<T>(self, rescore: T) -> Selfwhere T: IntoIterator, T::Item: Into<Rescore>,

Rescore

pub fn suggest<T, U>(self, name: T, suggester: U) -> Selfwhere T: ToString, U: Into<Suggester>,

Suggest

pub fn stored_fields<T>(self, stored_fields: T) -> Selfwhere T: Into<StoredFields>,

A collection of stored fields

pub fn docvalue_fields<T>(self, docvalue_fields: T) -> Selfwhere T: IntoIterator, T::Item: ToString,

A collection of docvalue fields

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

Point in time

pub fn search_after<T>(self, sort_values: T) -> Selfwhere T: Into<Terms>,

Search after a set of sort values.

pub fn timeout<T>(self, timeout: T) -> Selfwhere T: Into<Time>,

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

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

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Selfwhere N: Into<AggregationName>, A: Into<Aggregation>,

Pushes aggregation

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a copy 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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Search

Returns the “default value” for a type.

impl PartialEq<Search> for Search

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

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

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 Search

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 Search