[−][src]Struct elasticsearch::DeleteByQuery
Builder for the Delete By Query API
Deletes documents matching the provided query.
Methods
impl<'a, 'b, B> DeleteByQuery<'a, 'b, B> where
B: Body,
[src]
B: Body,
pub fn new(client: &'a Elasticsearch, parts: DeleteByQueryParts<'b>) -> Self
[src]
Creates a new instance of DeleteByQuery 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 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 body<T>(self, body: T) -> DeleteByQuery<'a, 'b, JsonBody<T>> where
T: Serialize,
[src]
T: Serialize,
The body for the API call
pub fn conflicts(self, conflicts: Conflicts) -> Self
[src]
What to do when the delete by query hits version conflicts?
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 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 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_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_docs(self, max_docs: i64) -> Self
[src]
Maximum number of documents to process (default: all documents)
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 refresh(self, refresh: bool) -> Self
[src]
Should the effected indexes be refreshed?
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 requests_per_second(self, requests_per_second: i64) -> Self
[src]
The throttle for this request in sub-requests per second. -1 means no throttle.
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 scroll_size(self, scroll_size: i64) -> Self
[src]
Size on the scroll request powering the delete by query
pub fn search_timeout(self, search_timeout: &'b str) -> Self
[src]
Explicit timeout for each search request. Defaults to no timeout.
pub fn search_type(self, search_type: SearchType) -> Self
[src]
Search operation type
pub fn size(self, size: i64) -> Self
[src]
Deprecated, please use max_docs
instead
pub fn slices(self, slices: Slices) -> Self
[src]
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(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 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]
Time each individual bulk request should wait for shards that are unavailable.
pub fn version(self, version: bool) -> Self
[src]
Specify whether to return document version as part of a hit
pub fn wait_for_active_shards(self, wait_for_active_shards: &'b str) -> Self
[src]
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(self, wait_for_completion: bool) -> Self
[src]
Should the request should block until the delete by query is complete.
pub async fn send(self) -> Result<Response, Error>
[src]
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>
[src]
fn clone(&self) -> DeleteByQuery<'a, 'b, B>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, 'b, B: Debug> Debug for DeleteByQuery<'a, 'b, B>
[src]
Auto Trait Implementations
impl<'a, 'b, B> !RefUnwindSafe for DeleteByQuery<'a, 'b, B>
impl<'a, 'b, B> Send for DeleteByQuery<'a, 'b, B> where
B: Send,
B: Send,
impl<'a, 'b, B> Sync for DeleteByQuery<'a, 'b, B> where
B: Sync,
B: Sync,
impl<'a, 'b, B> Unpin for DeleteByQuery<'a, 'b, B> where
B: Unpin,
B: Unpin,
impl<'a, 'b, B> !UnwindSafe for DeleteByQuery<'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>,