IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get API Update API »

› › ›

Delete API

edit

Delete API

edit

Delete Request

edit

A DeleteRequest requires the following arguments:

DeleteRequest request = new DeleteRequest(
        "posts",    
        "doc",     
        "1");

	Index
	Type
	Document id

Optional arguments

edit

The following arguments can optionally be provided:

request.routing("routing");

Routing value

request.parent("parent");

Parent value

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

	Timeout to wait for primary shard to become available as a `TimeValue`
	Timeout to wait for primary shard to become available as a `String`

request.setRefreshPolicy(WriteRequest.RefreshPolicy.WAIT_UNTIL); 
request.setRefreshPolicy("wait_for");

	Refresh policy as a `WriteRequest.RefreshPolicy` instance
	Refresh policy as a `String`

request.version(2);

Version

request.versionType(VersionType.EXTERNAL);

Version type

Synchronous Execution

edit

DeleteResponse deleteResponse = client.delete(request);

Asynchronous Execution

edit

client.deleteAsync(request, new ActionListener<DeleteResponse>() {
    @Override
    public void onResponse(DeleteResponse deleteResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
});

	Called when the execution is successfully completed. The response is provided as an argument
	Called in case of failure. The raised exception is provided as an argument

Delete Response

edit

The returned DeleteResponse allows to retrieve information about the executed operation as follows:

String index = deleteResponse.getIndex();
String type = deleteResponse.getType();
String id = deleteResponse.getId();
long version = deleteResponse.getVersion();
ReplicationResponse.ShardInfo shardInfo = deleteResponse.getShardInfo();
if (shardInfo.getTotal() != shardInfo.getSuccessful()) {
    
}
if (shardInfo.getFailed() > 0) {
    for (ReplicationResponse.ShardInfo.Failure failure : shardInfo.getFailures()) {
        String reason = failure.reason(); 
    }
}

	Handle the situation where number of successful shards is less than total shards
	Handle the potential failures

It is also possible to check whether the document was found or not:

DeleteRequest request = new DeleteRequest("posts", "doc", "does_not_exist");
DeleteResponse deleteResponse = client.delete(request);
if (deleteResponse.getResult() == DocWriteResponse.Result.NOT_FOUND) {
    
}

Do something if the document to be deleted was not found

If there is a version conflict, an ElasticsearchException will be thrown:

try {
    DeleteRequest request = new DeleteRequest("posts", "doc", "1").version(2);
    DeleteResponse deleteResponse = client.delete(request);
} catch (ElasticsearchException exception) {
    if (exception.status() == RestStatus.CONFLICT) {
        
    }
}

The raised exception indicates that a version conflict error was returned

« Get API Update API »