Docs
-->
Elasticsearch Reference [7.0] » Ingest node » Processors » Set Processor
«  Script Processor     Set Security User Processor  »

Set Processor

Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

Table 54. Set Options

Name Required Default Description

field

yes

-

The field to insert, upsert, or update. Supports template snippets.

value

yes

-

The value to be set for the field. Supports template snippets.

override

no

true

If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched.

if

no

-

Conditionally execute this processor.

on_failure

no

-

Handle failures for this processor. See Handling Failures in Pipelines.

ignore_failure

no

false

Ignore failures for this processor. See Handling Failures in Pipelines.

tag

no

-

An identifier for this processor. Useful for debugging and metrics. 


{
  "description" : "sets the value of count to 1"
  "set": {
    "field": "count",
    "value": 1
  }
}

This processor can also be used to copy data from one field to another. For example:

PUT _ingest/pipeline/set_os
{
  "description": "sets the value of host.os.name from the field os",
  "processors": [
    {
      "set": {
        "field": "host.os.name",
        "value": "{{os}}"
      }
    }
  ]
}

POST _ingest/pipeline/set_os/_simulate
{
  "docs": [
    {
      "_source": {
        "os": "Ubuntu"
      }
    }
  ]
}

Result:

{
  "docs" : [
    {
      "doc" : {
        "_index" : "_index",
        "_type" : "_doc",
        "_id" : "_id",
        "_source" : {
          "host" : {
            "os" : {
              "name" : "Ubuntu"
            }
          },
          "os" : "Ubuntu"
        },
        "_ingest" : {
          "timestamp" : "2019-03-11T21:54:37.909224Z"
        }
      }
    }
  ]
}
«  Script Processor     Set Security User Processor  »