Struct elasticsearch::Search [−][src]
pub struct Search<'a, 'b, B> { /* fields omitted */ }
Expand description
Builder for the Search API
Returns results matching a query.
Implementations
Creates a new instance of Search with the specified API parts
True or false to return the _source field or not, or a list of fields to return
A list of fields to exclude from the returned _source field
A list of fields to extract and return from the _source field
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all
string or when no indices have been specified)
Indicate if an error should be returned if there is a partial search failure or timeout
Specify whether wildcard and prefix queries should be analyzed (default: false)
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.
The body for the API call
Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
The default operator for query string query (AND or OR)
The field to use as default where no field prefix is given in the query string
A comma-separated list of fields to return as the docvalue representation of a field for each hit
Include the stack trace of returned errors.
Whether to expand wildcard expression to concrete indices that are open, closed or both.
Specify whether to return detailed information about score computation as part of a hit
A comma-separated list of filters used to reduce the response.
Adds a HTTP header
Whether specified concrete, expanded or aliased indices should be ignored when throttled
Whether specified concrete indices should be ignored when unavailable (missing or closed)
Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
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
The minimum compatible version that all shards involved in search should have for this request to be successful
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.
Specify the node or shard the operation should be performed on (default: random)
Specify if request cache should be used for this request or not, defaults to index level setting
Sets a request timeout for this API call.
The timeout is applied from when the request starts connecting until the response body has finished.
Indicates whether hits.total should be rendered as an integer or an object in the rest search response
A comma-separated list of specific routing values
Specify how long a consistent view of the index should be maintained for scrolled search
Search operation type
Specify whether to return sequence number and primary term of the last modification of each hit
The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
Specific ‘tag’ of the request for logging and statistical purposes
A comma-separated list of stored fields to return as part of a hit
Specify which field to use for suggestions
Specify suggest mode
How many suggestions to return in response
The source text for which the suggestions should be returned
The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
Whether to calculate and return scores even if they are not used for sorting
Indicate if the number of documents that match the query should be tracked
Specify whether aggregation and suggester names should be prefixed by their respective types in the response
Specify whether to return document version as part of a hit
Trait Implementations
Auto Trait Implementations
impl<'a, 'b, B> !RefUnwindSafe for Search<'a, 'b, B>
impl<'a, 'b, B> !UnwindSafe for Search<'a, 'b, B>
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more