ES高级用法：DeleteByQueryRequest

本文介绍: – 希望以上示例代码能够帮助你在Java中使用Elasticsearch的Rest High Level Client执行delete_by_query操作。- 另外，谨慎使用立即刷新策略，特别是在高吞吐量的生产环境中。祝你在使用Elasticsearch时顺利无阻！

背景

在Elasticsearch中，delete_by_query API 允许你基于查询条件删除文档。在Java中，你可以使用Elasticsearch的Rest High Level Client或者Transport Client来执行这个操作。

示例代码

下面是使用Rest High Level Client进行delete_by_query操作的一个示例代码。

首先，你需要添加Elasticsearch的依赖到你的项目中。如果你使用Maven，可以添加如下依赖到你的pom.xml文件中：

<dependency>
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
    <version>7.10.1</version>
</dependency>

确保版本与你的Elasticsearch集群版本相匹配。

下面是使用Rest High Level Client执行delete_by_query操作的Java代码示例：

import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.index.reindex.BulkByScrollResponse;
import org.elasticsearch.index.reindex.DeleteByQueryRequest;

import java.io.IOException;

public class DeleteByQueryExample {

    public static void main(String[] args) throws IOException {
        // 创建Elasticsearch客户端
        try (RestHighLevelClient client = new RestHighLevelClient(
                RestClient.builder(
                        new HttpHost("localhost", 9200, "http")
                )
        )) {
            // 创建DeleteByQueryRequest
            DeleteByQueryRequest request = new DeleteByQueryRequest("your_index"); // 替换为你的索引名
            request.setQuery(QueryBuilders.matchQuery("field", "value")); // 替换为你的查询条件

            // 执行delete_by_query操作
            BulkByScrollResponse response = client.deleteByQuery(request, RequestOptions.DEFAULT);

            // 输出结果
            System.out.println("Deleted documents: " + response.getDeleted());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在上面的代码中，我们首先创建了一个RestHighLevelClient实例用于与Elasticsearch集群通信。接着，我们构建了一个DeleteByQueryRequest对象，并设置了索引名和查询条件。然后，我们调用client.deleteByQuery方法来执行删除操作，并通过BulkByScrollResponse对象获取操作结果。

请注意，你需要根据你的具体需求替换your_index和查询条件。另外，HttpHost的参数应该与你的Elasticsearch集群配置相匹配。

在使用之前，请确保你的Elasticsearch集群版本与客户端库版本兼容，并且你已经正确配置了Elasticsearch的连接信息。

设置更新结果对搜索可见

为了确保delete_by_query操作后的结果能够立即对搜索可见，你可以设置RefreshPolicy为IMMEDIATE。这将导致操作完成后立即刷新索引。以下是在上面示例代码的基础上设置RefreshPolicy的方法：

import org.elasticsearch.client.RequestOptions;
import org.elasticsearch.client.RestClient;
import org.elasticsearch.client.RestHighLevelClient;
import org.elasticsearch.action.support.WriteRequest;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.index.reindex.BulkByScrollResponse;
import org.elasticsearch.index.reindex.DeleteByQueryRequest;
import org.apache.http.HttpHost;

import java.io.IOException;

public class DeleteByQueryExample {

    public static void main(String[] args) throws IOException {
        // 创建Elasticsearch客户端
        try (RestHighLevelClient client = new RestHighLevelClient(
                RestClient.builder(
                        new HttpHost("localhost", 9200, "http")
                )
        )) {
            // 创建DeleteByQueryRequest
            DeleteByQueryRequest request = new DeleteByQueryRequest("your_index"); // 替换为你的索引名
            request.setQuery(QueryBuilders.matchQuery("field", "value")); // 替换为你的查询条件

            // 设置RefreshPolicy为IMMEDIATE
            request.setRefresh(true); // 这是简写方式
            // 或者更明确地使用下面的方法
            // request.setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE);

            // 执行delete_by_query操作
            BulkByScrollResponse response = client.deleteByQuery(request, RequestOptions.DEFAULT);

            // 输出结果
            System.out.println("Deleted documents: " + response.getDeleted());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

在DeleteByQueryRequest对象上调用setRefresh(true)或setRefreshPolicy(WriteRequest.RefreshPolicy.IMMEDIATE)会将刷新策略设置为立即刷新。这意味着一旦delete_by_query操作完成，Elasticsearch会立即刷新相关的分片，使得删除的结果可以立即被搜索到。

请注意，频繁地使用IMMEDIATE刷新策略可能会对性能产生负面影响，因为每次刷新都是一个相对昂贵的操作。因此，它应该谨慎使用，特别是在高吞吐量的生产环境中。