org.elasticsearch.action.bulk.byscroll

Class DeleteByQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest<DeleteByQueryRequest>

org.elasticsearch.action.bulk.byscroll.DeleteByQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Streamable

public class DeleteByQueryRequest
extends AbstractBulkByScrollRequest<DeleteByQueryRequest>
implements IndicesRequest.Replaceable

Creates a new DeleteByQueryRequest that uses scrolling and bulk requests to delete all documents matching the query. This can have performance as well as visibility implications. Delete-by-query now has the following semantics:

• it's non-atomic, a delete-by-query may fail at any time while some documents matching the query have already been deleted
• it's syntactic sugar, a delete-by-query is equivalent to a scroll search and corresponding bulk-deletes by ID
• it's executed on a point-in-time snapshot, a delete-by-query will only delete the documents that are visible at the point in time the delete-by-query was started, equivalent to the scroll API
• it's consistent, a delete-by-query will yield consistent results across all replicas of a shard
• it's forward-compatible, a delete-by-query will only send IDs to the shards as deletes such that no queries are stored in the transaction logs that might not be supported in the future.
• it's results won't be visible until the index is refreshed.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest

SIZE_ALL_MATCHES

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequest()
DeleteByQueryRequest(SearchRequest search)

Method Summary

Modifier and Type	Method and Description
protected DeleteByQueryRequest	forSlice(TaskId slicingTask, SearchRequest slice) Build a new request for a slice of the parent request.
java.lang.String[]	indices() Returns the array of indices that the action relates to
IndicesRequest	indices(java.lang.String... indices) Sets the indices that the action relates to.
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
protected DeleteByQueryRequest	self() `this` cast to Self.
java.lang.String	toString()
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.action.bulk.byscroll.AbstractBulkByScrollRequest

createTask, doForSlice, getDescription, getMaxRetries, getRequestsPerSecond, getRetryBackoffInitialTime, getSearchRequest, getShouldStoreResult, getSize, getSlices, getTimeout, getWaitForActiveShards, isAbortOnVersionConflict, isRefresh, readFrom, searchToString, setAbortOnVersionConflict, setConflicts, setMaxRetries, setRefresh, setRequestsPerSecond, setRetryBackoffInitialTime, setShouldStoreResult, setSize, setSlices, setTimeout, setWaitForActiveShards, setWaitForActiveShards, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteByQueryRequest

public DeleteByQueryRequest()

DeleteByQueryRequest

public DeleteByQueryRequest(SearchRequest search)

Method Detail

self

protected DeleteByQueryRequest self()

Description copied from class: AbstractBulkByScrollRequest

`this` cast to Self. Used for building fluent methods without cast warnings.

Specified by:

self in class AbstractBulkByScrollRequest<DeleteByQueryRequest>

validate

public ActionRequestValidationException validate()

Overrides:

validate in class AbstractBulkByScrollRequest<DeleteByQueryRequest>

forSlice

protected DeleteByQueryRequest forSlice(TaskId slicingTask,
                                        SearchRequest slice)

Description copied from class: AbstractBulkByScrollRequest

Build a new request for a slice of the parent request.

Specified by:

forSlice in class AbstractBulkByScrollRequest<DeleteByQueryRequest>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

indices

public IndicesRequest indices(java.lang.String... indices)

Description copied from interface: IndicesRequest.Replaceable

Sets the indices that the action relates to.

Specified by:

indices in interface IndicesRequest.Replaceable

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest