org.elasticsearch.action.deletebyquery

Class DeleteByQueryRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<DeleteByQueryRequest>

org.elasticsearch.action.deletebyquery.DeleteByQueryRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

Creates a new DeleteByQueryRequest. Delete-by-query is since elasticsearch 2.0.0 moved into a plugin and is not part of elasticsearch core. In contrast to the previous, in-core, implementation delete-by-query now uses scan/scroll and the returned IDs do 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-actomic, a delete-by-query may fail at any time while some documents matching the query have already been deleted
• it's try-once, a delete-by-query may fail at any time and will not retry it's execution. All retry logic is left to the user
• it's syntactic sugar, a delete-by-query is equivalent to a scan/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 scan/scroll API
• it's consistent, a delete-by-query will yield consistent results across all replicas of a shard
• it's forward-compativle, 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 user refreshes the index.

The main reason why delete-by-query is now extracted as a plugin are:

• forward-compatibility, the previous implementation was prone to store unsupported queries in the transaction logs which is equvalent to data-loss
• consistency & correctness, the previous implementation was prone to produce different results on a shards replica which can essentially result in a corrupted index
• resiliency, the previous implementation could cause OOM errors, merge-storms and dramatic slowdowns if used incorrectly

While delete-by-query is a very useful feature, it's implementation is very tricky in system that is based on per-document modifications. The move towards a plugin based solution was mainly done to minimize the risk of cluster failures or corrupted indices which where easily possible wiht the previous implementation. Users that rely delete by query should install the plugin in oder to use this functionality.

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.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
DeleteByQueryRequest()
DeleteByQueryRequest(String... indices) Constructs a new delete by query request to run against the provided indices.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	indices()
DeleteByQueryRequest	indices(String... indices)
IndicesOptions	indicesOptions()
DeleteByQueryRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
String	routing()
DeleteByQueryRequest	routing(String... routings)
DeleteByQueryRequest	routing(String routing)
Scroll	scroll()
DeleteByQueryRequest	scroll(Scroll scroll)
DeleteByQueryRequest	scroll(String keepAlive)
DeleteByQueryRequest	scroll(TimeValue keepAlive)
int	size()
DeleteByQueryRequest	size(int size)
BytesReference	source()
DeleteByQueryRequest	source(byte[] querySource)
DeleteByQueryRequest	source(byte[] querySource, int offset, int length)
DeleteByQueryRequest	source(BytesReference querySource)
DeleteByQueryRequest	source(Map querySource)
DeleteByQueryRequest	source(QuerySourceBuilder sourceBuilder)
DeleteByQueryRequest	source(String querySource)
DeleteByQueryRequest	source(XContentBuilder builder)
TimeValue	timeout()
DeleteByQueryRequest	timeout(String timeout)
DeleteByQueryRequest	timeout(TimeValue timeout)
String	toString()
String[]	types()
DeleteByQueryRequest	types(String... types)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

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(String... indices)

Constructs a new delete by query request to run against the provided indices. No indices means it will run against all indices.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<DeleteByQueryRequest>

indices

public String[] indices()

Specified by:

indices in interface IndicesRequest

indices

public DeleteByQueryRequest indices(String... indices)

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public DeleteByQueryRequest indicesOptions(IndicesOptions indicesOptions)

types

public String[] types()

types

public DeleteByQueryRequest types(String... types)

source

public BytesReference source()

source

public DeleteByQueryRequest source(QuerySourceBuilder sourceBuilder)

source

public DeleteByQueryRequest source(Map querySource)

source

public DeleteByQueryRequest source(XContentBuilder builder)

source

public DeleteByQueryRequest source(String querySource)

source

public DeleteByQueryRequest source(byte[] querySource)

source

public DeleteByQueryRequest source(byte[] querySource,
                          int offset,
                          int length)

source

public DeleteByQueryRequest source(BytesReference querySource)

routing

public String routing()

routing

public DeleteByQueryRequest routing(String routing)

routing

public DeleteByQueryRequest routing(String... routings)

size

public DeleteByQueryRequest size(int size)

size

public int size()

scroll

public Scroll scroll()

scroll

public DeleteByQueryRequest scroll(Scroll scroll)

scroll

public DeleteByQueryRequest scroll(TimeValue keepAlive)

scroll

public DeleteByQueryRequest scroll(String keepAlive)

timeout

public TimeValue timeout()

timeout

public DeleteByQueryRequest timeout(TimeValue timeout)

timeout

public DeleteByQueryRequest timeout(String timeout)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<DeleteByQueryRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<DeleteByQueryRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object