Struct elasticsearch::DeleteByQuery

pub struct DeleteByQuery<'a, 'b, B> { /* fields omitted */ }

Builder for the Delete By Query API

Deletes documents matching the provided query.

Implementations

impl<'a, 'b, B> DeleteByQuery<'a, 'b, B> where
    B: Body, 

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

Creates a new instance of DeleteByQuery with the specified API parts

pub fn _source(mut self: 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(mut self: Self, _source_excludes: &'b [&'b str]) -> Self

A list of fields to exclude from the returned _source field

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

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

pub fn allow_no_indices(mut self: 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 analyze_wildcard(mut self: Self, analyze_wildcard: bool) -> Self

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

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

The analyzer to use for the query string

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

The body for the API call

pub fn conflicts(mut self: Self, conflicts: Conflicts) -> Self

What to do when the delete by query hits version conflicts?

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

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

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

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

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

Include the stack trace of returned errors.

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

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

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

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

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

Starting offset (default: 0)

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

Adds a HTTP header

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

Return human readable values for statistics.

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

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

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

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

pub fn max_docs(mut self: Self, max_docs: i64) -> Self

Maximum number of documents to process (default: all documents)

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

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

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

Pretty format the returned JSON response.

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

Query in the Lucene query string syntax

pub fn refresh(mut self: Self, refresh: bool) -> Self

Should the effected indexes be refreshed?

pub fn request_cache(mut self: 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(mut self: 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 requests_per_second(mut self: Self, requests_per_second: i64) -> Self

The throttle for this request in sub-requests per second. -1 means no throttle.

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

A comma-separated list of specific routing values

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

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

pub fn scroll_size(mut self: Self, scroll_size: i64) -> Self

Size on the scroll request powering the delete by query

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

Explicit timeout for each search request. Defaults to no timeout.

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

Search operation type

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

Deprecated, please use max_docs instead

pub fn slices(mut self: Self, slices: Slices) -> Self

The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to auto.

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

A comma-separated list of : pairs

pub fn source(mut self: 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(mut self: Self, stats: &'b [&'b str]) -> Self

Specific 'tag' of the request for logging and statistical purposes

pub fn terminate_after(mut self: 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(mut self: Self, timeout: &'b str) -> Self

Time each individual bulk request should wait for shards that are unavailable.

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

Specify whether to return document version as part of a hit

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

Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to all for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

pub fn wait_for_completion(mut self: Self, wait_for_completion: bool) -> Self

Should the request should block until the delete by query is complete.

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

Creates an asynchronous call to the Delete By Query API that can be awaited

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.