Convert processor
editConvert processor
editConverts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.
The supported types include: integer
, long
, float
, double
, string
, boolean
, ip
, and auto
.
Specifying boolean
will set the field to true if its string value is equal to true
(ignore case), to
false if its string value is equal to false
(ignore case), or it will throw an exception otherwise.
Specifying ip
will set the target field to the value of field
if it contains a valid IPv4 or IPv6 address
that can be indexed into an IP field type.
Specifying auto
will attempt to convert the string-valued field
into the closest non-string, non-IP type.
For example, a field whose value is "true"
will be converted to its respective boolean type: true
. Do note
that float takes precedence of double in auto
. A value of "242.15"
will "automatically" be converted to
242.15
of type float
. If a provided field cannot be appropriately converted, the processor will
still process successfully and leave the field value as-is. In such a case, target_field
will
be updated with the unconverted field value.
Table 9. Convert Options
Name | Required | Default | Description |
---|---|---|---|
|
yes |
- |
The field whose value is to be converted |
|
no |
|
The field to assign the converted value to, by default |
|
yes |
- |
The type to convert the existing value to |
|
no |
|
If |
|
no |
- |
Description of the processor. Useful for describing the purpose of the processor or its configuration. |
|
no |
- |
Conditionally execute the processor. See Conditionally run a processor. |
|
no |
|
Ignore failures for the processor. See Handling pipeline failures. |
|
no |
- |
Handle failures for the processor. See Handling pipeline failures. |
|
no |
- |
Identifier for the processor. Useful for debugging and metrics. |
PUT _ingest/pipeline/my-pipeline-id { "description": "converts the content of the id field to an integer", "processors" : [ { "convert" : { "field" : "id", "type": "integer" } } ] }