Struct Search

pub struct Search<'a, 'b, B> { /* private fields */ }

Builder for the Search API

Returns results matching a query.

Implementations

impl<'a, 'b, B> Search<'a, 'b, B>

where B: Body,

pub fn new(transport: &'a Transport, parts: SearchParts<'b>) -> Self

Creates a new instance of Search with the specified API parts

pub fn _source(self, _source: &'b [&'b str]) -> Self

True or false to return the _source field or not, or a list of fields to return

pub fn _source_excludes(self, _source_excludes: &'b [&'b str]) -> Self

A list of fields to exclude from the returned _source field

pub fn _source_includes(self, _source_includes: &'b [&'b str]) -> Self

A list of fields to extract and return from the _source field

pub fn allow_no_indices(self, allow_no_indices: bool) -> Self

Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

pub fn allow_partial_search_results( self, allow_partial_search_results: bool, ) -> Self

Indicate if an error should be returned if there is a partial search failure or timeout

pub fn analyze_wildcard(self, analyze_wildcard: bool) -> Self

Specify whether wildcard and prefix queries should be analyzed (default: false)

pub fn analyzer(self, analyzer: &'b str) -> Self

The analyzer to use for the query string

pub fn batched_reduce_size(self, batched_reduce_size: i64) -> Self

The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.

pub fn body<T>(self, body: T) -> Search<'a, 'b, JsonBody<T>>

where T: Serialize,

The body for the API call

pub fn ccs_minimize_roundtrips(self, ccs_minimize_roundtrips: bool) -> Self

Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution

pub fn default_operator(self, default_operator: DefaultOperator) -> Self

The default operator for query string query (AND or OR)

pub fn df(self, df: &'b str) -> Self

The field to use as default where no field prefix is given in the query string

pub fn docvalue_fields(self, docvalue_fields: &'b [&'b str]) -> Self

A comma-separated list of fields to return as the docvalue representation of a field for each hit

pub fn error_trace(self, error_trace: bool) -> Self

Include the stack trace of returned errors.

pub fn expand_wildcards(self, expand_wildcards: &'b [ExpandWildcards]) -> Self

Whether to expand wildcard expression to concrete indices that are open, closed or both.

pub fn explain(self, explain: bool) -> Self

Specify whether to return detailed information about score computation as part of a hit

pub fn filter_path(self, filter_path: &'b [&'b str]) -> Self

A comma-separated list of filters used to reduce the response.

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

Starting offset (default: 0)

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Adds a HTTP header

pub fn human(self, human: bool) -> Self

Return human readable values for statistics.

pub fn ignore_throttled(self, ignore_throttled: bool) -> Self

Whether specified concrete, expanded or aliased indices should be ignored when throttled

pub fn ignore_unavailable(self, ignore_unavailable: bool) -> Self

Whether specified concrete indices should be ignored when unavailable (missing or closed)

pub fn lenient(self, lenient: bool) -> Self

Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

pub fn max_concurrent_shard_requests( self, max_concurrent_shard_requests: i64, ) -> Self

The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests

pub fn min_compatible_shard_node( self, min_compatible_shard_node: &'b str, ) -> Self

The minimum compatible version that all shards involved in search should have for this request to be successful

pub fn pre_filter_shard_size(self, pre_filter_shard_size: i64) -> Self

A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.

pub fn preference(self, preference: &'b str) -> Self

Specify the node or shard the operation should be performed on (default: random)

pub fn pretty(self, pretty: bool) -> Self

Pretty format the returned JSON response.

pub fn q(self, q: &'b str) -> Self

Query in the Lucene query string syntax

pub fn request_cache(self, request_cache: bool) -> Self

Specify if request cache should be used for this request or not, defaults to index level setting

pub fn request_timeout(self, timeout: Duration) -> Self

Sets a request timeout for this API call.

The timeout is applied from when the request starts connecting until the response body has finished.

pub fn rest_total_hits_as_int(self, rest_total_hits_as_int: bool) -> Self

Indicates whether hits.total should be rendered as an integer or an object in the rest search response

pub fn routing(self, routing: &'b [&'b str]) -> Self

A comma-separated list of specific routing values

pub fn scroll(self, scroll: &'b str) -> Self

Specify how long a consistent view of the index should be maintained for scrolled search

pub fn search_type(self, search_type: SearchType) -> Self

Search operation type

pub fn seq_no_primary_term(self, seq_no_primary_term: bool) -> Self

Specify whether to return sequence number and primary term of the last modification of each hit

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

Number of hits to return (default: 10)

pub fn sort(self, sort: &'b [&'b str]) -> Self

A comma-separated list of <field>:<direction> pairs

pub fn source(self, source: &'b str) -> Self

The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.

pub fn stats(self, stats: &'b [&'b str]) -> Self

Specific ‘tag’ of the request for logging and statistical purposes

pub fn stored_fields(self, stored_fields: &'b [&'b str]) -> Self

A comma-separated list of stored fields to return as part of a hit

pub fn suggest_field(self, suggest_field: &'b str) -> Self

Specify which field to use for suggestions

pub fn suggest_mode(self, suggest_mode: SuggestMode) -> Self

Specify suggest mode

pub fn suggest_size(self, suggest_size: i64) -> Self

How many suggestions to return in response

pub fn suggest_text(self, suggest_text: &'b str) -> Self

The source text for which the suggestions should be returned

pub fn terminate_after(self, terminate_after: i64) -> Self

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.

pub fn timeout(self, timeout: &'b str) -> Self

Explicit operation timeout

pub fn track_scores(self, track_scores: bool) -> Self

Whether to calculate and return scores even if they are not used for sorting

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

Indicate if the number of documents that match the query should be tracked

pub fn typed_keys(self, typed_keys: bool) -> Self

Specify whether aggregation and suggester names should be prefixed by their respective types in the response

pub fn version(self, version: bool) -> Self

Specify whether to return document version as part of a hit

pub async fn send(self) -> Result<Response, Error>

Creates an asynchronous call to the Search API that can be awaited

Trait Implementations

impl<'a, 'b, B: Clone> Clone for Search<'a, 'b, B>

fn clone(&self) -> Search<'a, 'b, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b, B: Debug> Debug for Search<'a, 'b, B>

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

Formats the value using the given formatter.