elasticsearch/docs/reference/enrich-processor/split-processor.md
Colleen McGinnis 9bcd59596d
[docs] Prepare for docs-assembler (#125118)
* reorg files for docs-assembler and create toc.yml files

* fix build error, add redirects

* only toc

* move images
2025-03-20 12:09:12 -05:00

2.3 KiB

navigation_title mapped_pages
Split
https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html

Split processor [split-processor]

Splits a field into an array using a separator character. Only works on string fields.

$$$split-options$

Name Required Default Description
field yes - The field to split
separator yes - A regex which matches the separator, eg , or \s+
target_field no field The field to assign the split value to, by default field is updated in-place
ignore_missing no false If true and field does not exist, the processor quietly exits without modifying the document
preserve_trailing no false Preserves empty trailing fields, if any.
description no - Description of the processor. Useful for describing the purpose of the processor or its configuration.
if no - Conditionally execute the processor. See Conditionally run a processor.
ignore_failure no false Ignore failures for the processor. See Handling pipeline failures.
on_failure no - Handle failures for the processor. See Handling pipeline failures.
tag no - Identifier for the processor. Useful for debugging and metrics.
{
  "split": {
    "field": "my_field",
    "separator": "\\s+" <1>
  }
}
  1. Treat all consecutive whitespace characters as a single separator

If the preserve_trailing option is enabled, any trailing empty fields in the input will be preserved. For example, in the configuration below, a value of A,,B,, in the my_field property will be split into an array of five elements ["A", "", "B", "", ""] with two empty trailing fields. If the preserve_trailing property were not enabled, the two empty trailing fields would be discarded resulting in the three-element array ["A", "", "B"].

{
  "split": {
    "field": "my_field",
    "separator": ",",
    "preserve_trailing": true
  }
}