[−][src]Struct elasticsearch::Search
Builder for the Search API
Returns results matching a query.
Methods
impl<'a, 'b, B> Search<'a, 'b, B> where
B: Body,
[src]
B: Body,
pub fn new(client: &'a Elasticsearch, parts: SearchParts<'b>) -> Self
[src]
Creates a new instance of Search with the specified API parts
pub fn _source(self, _source: &'b [&'b str]) -> Self
[src]
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
[src]
A list of fields to exclude from the returned _source field
pub fn _source_includes(self, _source_includes: &'b [&'b str]) -> Self
[src]
A list of fields to extract and return from the _source field
pub fn allow_no_indices(self, allow_no_indices: bool) -> Self
[src]
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
[src]
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
[src]
Specify whether wildcard and prefix queries should be analyzed (default: false)
pub fn analyzer(self, analyzer: &'b str) -> Self
[src]
The analyzer to use for the query string
pub fn batched_reduce_size(self, batched_reduce_size: i64) -> Self
[src]
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,
[src]
T: Serialize,
The body for the API call
pub fn ccs_minimize_roundtrips(self, ccs_minimize_roundtrips: bool) -> Self
[src]
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
[src]
The default operator for query string query (AND or OR)
pub fn df(self, df: &'b str) -> Self
[src]
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
[src]
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
[src]
Include the stack trace of returned errors.
pub fn expand_wildcards(self, expand_wildcards: ExpandWildcards) -> Self
[src]
Whether to expand wildcard expression to concrete indices that are open, closed or both.
pub fn explain(self, explain: bool) -> Self
[src]
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
[src]
A comma-separated list of filters used to reduce the response.
pub fn from(self, from: i64) -> Self
[src]
Starting offset (default: 0)
pub fn header(self, key: HeaderName, value: HeaderValue) -> Self
[src]
Adds a HTTP header
pub fn human(self, human: bool) -> Self
[src]
Return human readable values for statistics.
pub fn ignore_throttled(self, ignore_throttled: bool) -> Self
[src]
Whether specified concrete, expanded or aliased indices should be ignored when throttled
pub fn ignore_unavailable(self, ignore_unavailable: bool) -> Self
[src]
Whether specified concrete indices should be ignored when unavailable (missing or closed)
pub fn lenient(self, lenient: bool) -> Self
[src]
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
[src]
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 pre_filter_shard_size(self, pre_filter_shard_size: i64) -> Self
[src]
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 it's 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
[src]
Specify the node or shard the operation should be performed on (default: random)
pub fn pretty(self, pretty: bool) -> Self
[src]
Pretty format the returned JSON response.
pub fn q(self, q: &'b str) -> Self
[src]
Query in the Lucene query string syntax
pub fn request_cache(self, request_cache: bool) -> Self
[src]
Specify if request cache should be used for this request or not, defaults to index level setting
pub fn rest_total_hits_as_int(self, rest_total_hits_as_int: bool) -> Self
[src]
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
[src]
A comma-separated list of specific routing values
pub fn scroll(self, scroll: &'b str) -> Self
[src]
Specify how long a consistent view of the index should be maintained for scrolled search
pub fn search_type(self, search_type: SearchType) -> Self
[src]
Search operation type
pub fn seq_no_primary_term(self, seq_no_primary_term: bool) -> Self
[src]
Specify whether to return sequence number and primary term of the last modification of each hit
pub fn size(self, size: i64) -> Self
[src]
Number of hits to return (default: 10)
pub fn sort(self, sort: &'b [&'b str]) -> Self
[src]
A comma-separated list of
pub fn source(self, source: &'b str) -> Self
[src]
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
[src]
Specific 'tag' of the request for logging and statistical purposes
pub fn stored_fields(self, stored_fields: &'b [&'b str]) -> Self
[src]
A comma-separated list of stored fields to return as part of a hit
pub fn suggest_field(self, suggest_field: &'b str) -> Self
[src]
Specify which field to use for suggestions
pub fn suggest_mode(self, suggest_mode: SuggestMode) -> Self
[src]
Specify suggest mode
pub fn suggest_size(self, suggest_size: i64) -> Self
[src]
How many suggestions to return in response
pub fn suggest_text(self, suggest_text: &'b str) -> Self
[src]
The source text for which the suggestions should be returned
pub fn terminate_after(self, terminate_after: i64) -> Self
[src]
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
[src]
Explicit operation timeout
pub fn track_scores(self, track_scores: bool) -> Self
[src]
Whether to calculate and return scores even if they are not used for sorting
pub fn track_total_hits(self, track_total_hits: TrackTotalHits) -> Self
[src]
Indicate if the number of documents that match the query should be tracked
pub fn typed_keys(self, typed_keys: bool) -> Self
[src]
Specify whether aggregation and suggester names should be prefixed by their respective types in the response
pub fn version(self, version: bool) -> Self
[src]
Specify whether to return document version as part of a hit
pub async fn send(self) -> Result<Response, Error>
[src]
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>
[src]
impl<'a, 'b, B: Debug> Debug for Search<'a, 'b, B>
[src]
Auto Trait Implementations
impl<'a, 'b, B> !RefUnwindSafe for Search<'a, 'b, B>
impl<'a, 'b, B> Send for Search<'a, 'b, B> where
B: Send,
B: Send,
impl<'a, 'b, B> Sync for Search<'a, 'b, B> where
B: Sync,
B: Sync,
impl<'a, 'b, B> Unpin for Search<'a, 'b, B> where
B: Unpin,
B: Unpin,
impl<'a, 'b, B> !UnwindSafe for Search<'a, 'b, B>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DynClone for T where
T: Clone,
[src]
T: Clone,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,