摘要：異步方法不會阻塞并立即返回，完成后，如果執行成功完成，則使用方法回調，如果失敗則使用方法。在整個失敗時調用，在這種情況下，引發異常作為參數提供，并且沒有執行任何操作。檢查請求是否超時。獲取處理的文檔總數。已刪除的文檔數。已執行的批次數。

UpdateByQueryRequest可用于更新索引中的文檔。

它需要在其上執行更新的現有索引（或一組索引）。

最簡單的UpdateByQueryRequest形式如下所示：

UpdateByQueryRequest request = new UpdateByQueryRequest("source1", "source2");

在一組索引上創建UpdateByQueryRequest。

默認情況下，版本沖突會中止UpdateByQueryRequest進程，但你可以通過在請求體中設置它為proceed來計數它們。

request.setConflicts("proceed");

設置proceed當版本沖突。

你可以通過添加查詢來限制文檔。

request.setQuery(new TermQueryBuilder("user", "kimchy"));

僅復制將字段user設置為kimchy的文檔。

也可以通過設置大小來限制處理文檔的數量。

request.setSize(10);

只復制10條文檔。

默認情況下，UpdateByQueryRequest使用1000批次，你可以使用setBatchSize更改批量大小。

request.setBatchSize(100);

使用100個文檔批次。

按查詢更新還可以通過指定管道來使用攝取功能。

request.setPipeline("my_pipeline");

UpdateByQueryRequest還支持修改文檔的script，以下示例說明了這一點。

request.setScript(
    new Script(
        ScriptType.INLINE, "painless",
        "if (ctx._source.user == "kimchy") {ctx._source.likes++;}",
        Collections.emptyMap()));

setScript使用戶為kimchy的所有文檔上的likes字段遞增。

UpdateByQueryRequest還有助于使用sliced-scroll自動并行化到_uid上的切片，使用setSlices指定要使用的切片數。

request.setSlices(2);

設置要使用的切片數。

UpdateByQueryRequest使用scroll參數來控制它保持“搜索上下文”活動的時間。

request.setScroll(TimeValue.timeValueMinutes(10));

設置滾動時間。

如果提供路由，則路由將復制到滾動查詢，從而將進程限制為與該路由值匹配的碎片。

request.setRouting("=cat");

設置路由。

除上述選項外，還可以選擇提供以下參數：

request.setTimeout(TimeValue.timeValueMinutes(2));

等待查詢請求更新執行作為TimeValue的超時時間。

request.setRefresh(true);

通過調用查詢更新后刷新索引。

request.setIndicesOptions(IndicesOptions.LENIENT_EXPAND_OPEN);

設置索引選項。

BulkByScrollResponse bulkResponse = client.updateByQuery(request, RequestOptions.DEFAULT);

通過查詢更新請求異步執行需要將UpdateByQueryRequest實例和ActionListener實例傳遞給異步方法：

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

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

異步方法不會阻塞并立即返回，完成后，如果執行成功完成，則使用onResponse方法回調ActionListener，如果失敗則使用onFailure方法。

BulkByScrollResponse的典型監聽器如下所示：

ActionListener listener = new ActionListener() {
    @Override
    public void onResponse(BulkByScrollResponse bulkResponse) {
        
    }

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

onResponse — 執行成功完成時調用，響應作為參數提供，并包含已執行的每個操作的單個結果列表，請注意，一個或多個操作可能已失敗，而其他操作已成功執行。

onFailure — 在整個UpdateByQueryRequest失敗時調用，在這種情況下，引發異常作為參數提供，并且沒有執行任何操作。

返回的BulkByScrollResponse包含有關已執行操作的信息，并允許迭代每個結果，如下所示：

TimeValue timeTaken = bulkResponse.getTook(); 
boolean timedOut = bulkResponse.isTimedOut(); 
long totalDocs = bulkResponse.getTotal(); 
long updatedDocs = bulkResponse.getUpdated(); 
long deletedDocs = bulkResponse.getDeleted(); 
long batches = bulkResponse.getBatches(); 
long noops = bulkResponse.getNoops(); 
long versionConflicts = bulkResponse.getVersionConflicts(); 
long bulkRetries = bulkResponse.getBulkRetries(); 
long searchRetries = bulkResponse.getSearchRetries(); 
TimeValue throttledMillis = bulkResponse.getStatus().getThrottled(); 
TimeValue throttledUntilMillis = bulkResponse.getStatus().getThrottledUntil(); 
List searchFailures = bulkResponse.getSearchFailures(); 
List bulkFailures = bulkResponse.getBulkFailures();

獲取總耗時。

檢查請求是否超時。

獲取處理的文檔總數。

已更新的文檔數。

已刪除的文檔數。

已執行的批次數。

跳過的文檔數。

版本沖突數。

請求必須重試批量索引操作的次數。

請求必須重試搜索操作的次數。

此請求限制的總時間不包括當前正在休眠的當前節流時間。

任何當前節流閥休眠的剩余延遲或如果不休眠則為0。

搜索階段的失敗。

批量索引操作期間的失敗。