Elasticsearch 中如何使用 Delete By Query API？

推荐答案

在 Elasticsearch 中，Delete By Query API 用于根据查询条件删除文档。以下是一个基本的使用示例：

POST /your_index/_delete_by_query
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

在这个示例中，your_index 是你要操作的索引名称，field_name 是你要匹配的字段名，value_to_match 是你要匹配的字段值。执行这个请求后，Elasticsearch 会删除所有匹配该查询条件的文档。

本题详细解读

1. Delete By Query API 的基本用法

Delete By Query API 允许你通过指定一个查询条件来删除匹配的文档。这个 API 是异步执行的，意味着它会返回一个任务 ID，你可以通过这个 ID 来查询删除操作的进度。

2. 请求结构

Delete By Query API 的请求结构如下：

POST /<index>/_delete_by_query
{
  "query": {
    "<query_type>": {
      "<field_name>": "<value>"
    }
  }
}

• <index>：指定要删除文档的索引名称。
• <query_type>：指定查询类型，如 match、term、range 等。
• <field_name>：指定要匹配的字段名。
• <value>：指定要匹配的字段值。

3. 异步执行与任务管理

由于 Delete By Query API 是异步执行的，Elasticsearch 会返回一个任务 ID。你可以通过以下方式查询任务的执行状态：

GET /_tasks/<task_id>

4. 删除操作的确认

在执行删除操作之前，你可以使用 _validate API 来验证查询条件是否正确：

POST /your_index/_validate/query?explain
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

5. 删除操作的并发控制

你可以通过设置 conflicts 参数来控制并发删除操作的行为。默认情况下，conflicts 参数设置为 abort，表示在遇到冲突时中止操作。你可以将其设置为 proceed，以继续执行删除操作：

POST /your_index/_delete_by_query?conflicts=proceed
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

6. 删除操作的超时设置

你可以通过设置 timeout 参数来控制删除操作的超时时间：

POST /your_index/_delete_by_query?timeout=10m
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

在这个示例中，timeout 参数设置为 10 分钟。

7. 删除操作的滚动大小

你可以通过设置 scroll_size 参数来控制每次删除操作的文档数量：

POST /your_index/_delete_by_query?scroll_size=1000
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

在这个示例中，scroll_size 参数设置为 1000，表示每次删除 1000 个文档。

8. 删除操作的版本控制

你可以通过设置 version 参数来控制删除操作的版本控制行为：

POST /your_index/_delete_by_query?version=true
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

在这个示例中，version 参数设置为 true，表示在删除操作中启用版本控制。

9. 删除操作的批量处理

你可以通过设置 requests_per_second 参数来控制删除操作的速率：

POST /your_index/_delete_by_query?requests_per_second=100
{
  "query": {
    "match": {
      "field_name": "value_to_match"
    }
  }
}

在这个示例中，requests_per_second 参数设置为 100，表示每秒最多执行 100 个删除请求。

10. 删除操作的取消

你可以通过以下方式取消正在执行的删除操作：

POST /_tasks/<task_id>/_cancel

在这个示例中，<task_id> 是你要取消的任务 ID。