Link Search Menu Expand Document Documentation Menu

Set 处理器

set 处理器用于在文档中添加或更新字段。它设置一个字段并将其与指定值关联。如果字段已存在,则其值将替换为提供的值,除非 override 参数设置为 false。当 overridefalse 且指定字段存在时,字段的值保持不变。

以下是 set 处理器的语法

{
  "description": "...",
  "processors": [
    {
      "set": {
        "field": "new_field",
        "value": "some_value"
      }
    }
  ]
}

配置参数

下表列出了 set 处理器所需和可选的参数。

参数 必需/可选 描述
field 必需 要设置或更新的字段名称。支持模板片段
value 必需 分配给字段的值。支持模板片段
override 可选 一个布尔标志,确定处理器是否应覆盖字段的现有值。
ignore_empty_value 可选 一个布尔标志,确定处理器是否应忽略 null 值或空字符串。默认为 false
description 可选 处理器的目的或配置说明。
if 可选 指定条件性执行处理器。
ignore_failure 可选 指定忽略处理器失败。参见处理管道失败
on_failure 可选 指定处理器在执行失败时要运行的处理器列表。这些处理器按照指定的顺序执行。
tag 可选 处理器的标识符标签。有助于调试以区分相同类型的处理器。

使用处理器

按照以下步骤在管道中使用处理器。

步骤 1:创建管道

以下查询创建一个名为 set-pipeline 的管道,它使用 set 处理器向文档添加一个新字段 new_field,其值为 some_value

PUT _ingest/pipeline/set-pipeline
{
  "description": "Adds a new field 'new_field' with the value 'some_value'",
  "processors": [
    {
      "set": {
        "field": "new_field",
        "value": "some_value"
      }
    }
  ]
}

步骤 2(可选):测试管道

建议在摄取文档之前测试您的管道。

要测试管道,请运行以下查询

POST _ingest/pipeline/set-pipeline/_simulate
{
  "docs": [
    {
      "_source": {
        "existing_field": "value"
      }
    }
  ]
}

响应

以下示例响应确认管道按预期工作

{
  "docs": [
    {
      "doc": {
        "_index": "_index",
        "_id": "_id",
        "_source": {
          "existing_field": "value",
          "new_field": "some_value"
        },
        "_ingest": {
          "timestamp": "2024-05-30T21:56:15.066180712Z"
        }
      }
    }
  ]
}

步骤 3:摄取文档

以下查询将文档摄取到名为 testindex1 的索引中

POST testindex1/_doc?pipeline=set-pipeline
{
  "existing_field": "value"
}

响应

该请求将文档索引到 testindex1 索引中,然后索引所有 new_field 设置为 some_value 的文档,如下面的响应所示

{
  "_index": "testindex1",
  "_id": "1",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}

步骤 4(可选):检索文档

要检索文档,请运行以下查询

GET testindex1/_doc/1

剩余 350 字符

有问题?

想贡献?