Link Search Menu Expand Document Documentation Menu
文档

脚本处理器

script 处理器执行内联和存储的脚本，这些脚本可以在摄取过程中修改或转换 OpenSearch 文档中的数据。处理器使用脚本缓存来提高性能，因为脚本可能会为每个文档重新编译。有关在 OpenSearch 中使用脚本的信息，请参阅 脚本 API。

以下是 script 处理器的语法：

{
  "processor": {
    "script": {
      "source": "<script_source>",
      "lang": "<script_language>",
      "params": {
        "<param_name>": "<param_value>"
      }
    }
  }
}

配置参数

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

参数 必需/可选 描述
source 可选 要执行的 Painless 脚本。必须指定 id 或 source — 但不能同时指定两者。如果指定了 source，则使用提供的源代码执行脚本。
id 可选 使用 创建存储脚本 API 预先创建的存储脚本的 ID。必须指定 id 或 source，但不能同时指定两者。如果指定了 id，则从具有指定 ID 的存储脚本中检索脚本源代码。
lang 可选 脚本的编程语言。默认为 painless。
params 可选 可以传递给脚本的参数。
description 可选 处理器的目的或配置说明。
if 可选 指定条件性执行处理器。
ignore_failure 可选 指定忽略处理器失败。参见处理管道失败。
on_failure 可选 指定处理器在执行失败时要运行的处理器列表。这些处理器按照指定的顺序执行。请参阅 处理管道故障。
tag 可选 处理器的标识符标签。有助于调试以区分相同类型的处理器。

使用处理器

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

步骤 1：创建管道

以下查询创建了一个名为 my-script-pipeline 的管道，该管道使用 script 处理器将 message 字段转换为大写：

PUT _ingest/pipeline/my-script-pipeline
{
  "description": "Example pipeline using the ScriptProcessor",
  "processors": [
    {
      "script": {
        "source": "ctx.message = ctx.message.toUpperCase()",
        "lang": "painless",
        "description": "Convert message field to uppercase"
      }
    }
  ]
}

步骤 2（可选）：测试管道

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

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

POST _ingest/pipeline/my-script-pipeline/_simulate
{
  "docs": [
    {
      "_source": {
        "message": "hello, world!"
      }
    }
  ]
}

响应

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

{
  "docs": [
    {
      "doc": {
        "_index": "_index",
        "_id": "_id",
        "_source": {
          "message": "HELLO, WORLD!"
        },
        "_ingest": {
          "timestamp": "2024-05-30T16:24:23.30265405Z"
        }
      }
    }
  ]
}

步骤 3：摄取文档

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

POST testindex1/_doc?pipeline=my-script-pipeline
{
  "message": "hello, world!"
}

响应

响应确认文档已索引到 testindex1，并且所有带有转换为大写的 message 字段的文档都已索引。

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

步骤 4（可选）：检索文档

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

GET testindex1/_doc/1

剩余 350 字符

有问题？。

想贡献吗？或。