Elasticsearch Java High Level REST Client（Delete API）

Delete API

Delete請求

DeleteRequest沒有參數。

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

• posts — 索引。
• doc — 類型。
• 1 — 文檔id。

可選參數

能夠選擇提供如下參數：

request.routing("routing");

• 路由值。

request.parent("parent");

• parent值。

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

• 等待主碎片可用的做爲TimeValue的超時。
• 等待主碎片可用的做爲String 的超時。

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

• 將刷新策略做爲WriteRequest.RefreshPolicy實例。
• 將刷新策略做爲String。

request.version(2);

• 版本。

request.versionType(VersionType.EXTERNAL);

• 版本類型。

同步執行

如下列方式執行DeleteRequest時，客戶端在繼續執行代碼以前等待返回DeleteResponse：

DeleteResponse deleteResponse = client.delete(
        request, RequestOptions.DEFAULT);

異步執行

執行DeleteRequest也能夠以異步方式完成，以便客戶端能夠直接返回，用戶須要經過將請求和偵聽器傳遞給異步刪除方法來指定響應或潛在故障的處理方式：

client.deleteAsync(request, RequestOptions.DEFAULT, listener);

• 要執行的DeleteRequest和執行完成時要使用的ActionListener。

異步方法不會阻塞並當即返回，完成後，若是執行成功完成，則使用onResponse方法回調ActionListener，若是失敗則使用onFailure方法。

delete的典型偵聽器以下所示：

listener = new ActionListener<DeleteResponse>() {
    @Override
    public void onResponse(DeleteResponse deleteResponse) {
        
    }

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

• onResponse — 執行成功完成時調用。
• onFailure — 在整個DeleteRequest失敗時調用。

Delete響應

返回的DeleteResponse容許檢索有關已執行操做的信息，以下所示：

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(); 
    }
}

• 處理成功碎片數小於總分片數的狀況。
• 處理潛在的失敗。

還能夠檢查文檔是否被找到：

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

• 若是找不到要刪除的文檔，請執行某些操做。

若是存在版本衝突，則拋出ElasticsearchException：

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

• 引起的異常表示返回了版本衝突錯誤。

---

上一篇：Exists API