mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
141 lines
3.6 KiB
Text
141 lines
3.6 KiB
Text
[[set-processor]]
|
|
=== Set processor
|
|
++++
|
|
<titleabbrev>Set</titleabbrev>
|
|
++++
|
|
|
|
Sets one field and associates it with the specified value. If the field already exists,
|
|
its value will be replaced with the provided one.
|
|
|
|
[[set-options]]
|
|
.Set Options
|
|
[options="header"]
|
|
|======
|
|
| Name | Required | Default | Description
|
|
| `field` | yes | - | The field to insert, upsert, or update. Supports <<accessing-template-fields,template snippets>>.
|
|
| `value` | yes* | - | The value to be set for the field. Supports <<accessing-template-fields,template snippets>>. May specify only one of `value` or `copy_from`.
|
|
| `copy_from` | no | - | The origin field which will be copied to `field`, cannot set `value` simultaneously. Supported data types are `boolean`, `number`, `array`, `object`, `string`, `date`, etc.
|
|
| `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.
|
|
| `ignore_empty_value` | no | `false` | If `true` and `value` is a <<accessing-template-fields,template snippet>> that evaluates to `null` or the empty string, the processor quietly exits without modifying the document
|
|
include::common-options.asciidoc[]
|
|
|======
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"description" : "sets the value of count to 1",
|
|
"set": {
|
|
"field": "count",
|
|
"value": 1
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|
|
|
|
This processor can also be used to copy data from one field to another. For example:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
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:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"docs" : [
|
|
{
|
|
"doc" : {
|
|
"_index" : "_index",
|
|
"_id" : "_id",
|
|
"_source" : {
|
|
"host" : {
|
|
"os" : {
|
|
"name" : "Ubuntu"
|
|
}
|
|
},
|
|
"os" : "Ubuntu"
|
|
},
|
|
"_ingest" : {
|
|
"timestamp" : "2019-03-11T21:54:37.909224Z"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/2019-03-11T21:54:37.909224Z/$body.docs.0.doc._ingest.timestamp/]
|
|
The contents of a field including complex values such as arrays and objects can be copied to another field using `copy_from`:
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ingest/pipeline/set_bar
|
|
{
|
|
"description": "sets the value of bar from the field foo",
|
|
"processors": [
|
|
{
|
|
"set": {
|
|
"field": "bar",
|
|
"copy_from": "foo"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
|
|
POST _ingest/pipeline/set_bar/_simulate
|
|
{
|
|
"docs": [
|
|
{
|
|
"_source": {
|
|
"foo": ["foo1", "foo2"]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
Result:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"docs" : [
|
|
{
|
|
"doc" : {
|
|
"_index" : "_index",
|
|
"_id" : "_id",
|
|
"_source" : {
|
|
"bar": ["foo1", "foo2"],
|
|
"foo": ["foo1", "foo2"]
|
|
},
|
|
"_ingest" : {
|
|
"timestamp" : "2020-09-30T12:55:17.742795Z"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/2020-09-30T12:55:17.742795Z/$body.docs.0.doc._ingest.timestamp/]
|