Module org.elasticsearch.server

Package org.elasticsearch.index.reindex

Class DeleteByQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.index.reindex.AbstractBulkByScrollRequest<DeleteByQueryRequest>

org.elasticsearch.index.reindex.DeleteByQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

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

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 interface org.elasticsearch.action.IndicesRequest

IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcards

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.index.reindex.AbstractBulkByScrollRequest

AUTO_SLICES, AUTO_SLICES_VALUE, DEFAULT_SCROLL_SIZE, DEFAULT_SCROLL_TIMEOUT, MAX_DOCS_ALL_MATCHES

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DeleteByQueryRequest()
DeleteByQueryRequest(String... indices)
DeleteByQueryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
DeleteByQueryRequest	forSlice(TaskId slicingTask, SearchRequest slice, int totalSlices)	Build a new request for a slice of the parent request.
int	getBatchSize()	Gets the batch size for this request
String	getRouting()	Gets the routing value used for this request
boolean	includeDataStreams()	Determines whether the request should be applied to data streams.
String[]	indices()	Returns the array of indices that the action relates to
DeleteByQueryRequest	indices(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.
DeleteByQueryRequest	setBatchSize(int size)	The scroll size to control number of documents processed per batch
DeleteByQueryRequest	setIndicesOptions(IndicesOptions indicesOptions)	Set the IndicesOptions for controlling unavailable indices
DeleteByQueryRequest	setQuery(QueryBuilder query)	Set the query for selective delete
DeleteByQueryRequest	setRouting(String routing)	Set routing limiting the process to the shards that match that routing value
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()

Methods inherited from class org.elasticsearch.index.reindex.AbstractBulkByScrollRequest

createTask, doForSlice, getDescription, getMaxDocs, getMaxRetries, getRequestsPerSecond, getRetryBackoffInitialTime, getScrollTime, getSearchRequest, getShouldStoreResult, getSlices, getTimeout, getWaitForActiveShards, isAbortOnVersionConflict, isRefresh, searchToString, setAbortOnVersionConflict, setConflicts, setMaxDocs, setMaxRetries, setRefresh, setRequestsPerSecond, setRetryBackoffInitialTime, setScroll, setShouldStoreResult, setSlices, setTimeout, setWaitForActiveShards, setWaitForActiveShards, writeTo

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, getRequestId, setParentTask, setRequestId

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.IndicesRequest.Replaceable

allowsRemoteIndices

Methods inherited from interface org.elasticsearch.core.RefCounted

mustIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

DeleteByQueryRequest

public DeleteByQueryRequest()

DeleteByQueryRequest

public DeleteByQueryRequest(String... indices)

DeleteByQueryRequest

public DeleteByQueryRequest(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

setQuery

public DeleteByQueryRequest setQuery(QueryBuilder query)

Set the query for selective delete

setRouting

public DeleteByQueryRequest setRouting(String routing)

Set routing limiting the process to the shards that match that routing value

setBatchSize

public DeleteByQueryRequest setBatchSize(int size)

The scroll size to control number of documents processed per batch

setIndicesOptions

public DeleteByQueryRequest setIndicesOptions(IndicesOptions indicesOptions)

Set the IndicesOptions for controlling unavailable indices

getBatchSize

public int getBatchSize()

Gets the batch size for this request

getRouting

public String getRouting()

Gets the routing value used for this request

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>

includeDataStreams

public boolean includeDataStreams()

Description copied from interface: IndicesRequest

Determines whether the request should be applied to data streams. When false, none of the names or wildcard expressions in IndicesRequest.indices() should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.

Specified by:

includeDataStreams in interface IndicesRequest

validate

public ActionRequestValidationException validate()

Overrides:

validate in class AbstractBulkByScrollRequest<DeleteByQueryRequest>

forSlice

public DeleteByQueryRequest forSlice(TaskId slicingTask,
 SearchRequest slice,
 int totalSlices)

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 String toString()

Overrides:

toString in class TransportRequest

indices

public DeleteByQueryRequest indices(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 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

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException