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:

org.elasticsearch.action.IndicesRequest, org.elasticsearch.action.IndicesRequest.Replaceable, org.elasticsearch.common.io.stream.Streamable

public class DeleteByQueryRequest
extends AbstractBulkByScrollRequest<DeleteByQueryRequest>
implements org.elasticsearch.action.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

org.elasticsearch.transport.TransportRequest.Empty

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

org.elasticsearch.action.IndicesRequest.Replaceable

Field Summary

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

SIZE_ALL_MATCHES

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequest()
DeleteByQueryRequest(org.elasticsearch.action.search.SearchRequest search)

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	indices()
org.elasticsearch.action.IndicesRequest	indices(java.lang.String... indices)
org.elasticsearch.action.support.IndicesOptions	indicesOptions()
protected DeleteByQueryRequest	self() `this` cast to Self.
java.lang.String	toString()
org.elasticsearch.action.ActionRequestValidationException	validate()

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

createTask, doForSlice, 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

getDescription, 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(org.elasticsearch.action.search.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 org.elasticsearch.action.ActionRequestValidationException validate()

Overrides:

validate in class AbstractBulkByScrollRequest<DeleteByQueryRequest>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

indices

public org.elasticsearch.action.IndicesRequest indices(java.lang.String... indices)

Specified by:

indices in interface org.elasticsearch.action.IndicesRequest.Replaceable

indices

public java.lang.String[] indices()

Specified by:

indices in interface org.elasticsearch.action.IndicesRequest

indicesOptions

public org.elasticsearch.action.support.IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface org.elasticsearch.action.IndicesRequest