Back to Elasticsearch

Join processor [join-processor]

docs/reference/enrich-processor/join-processor.md

9.4.01.4 KB
Original Source

Join processor [join-processor]

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

$$$join-options$$$

NameRequiredDefaultDescription
fieldyes-Field containing array values to join
separatoryes-The separator character
target_fieldnofieldThe field to assign the joined value to, by default field is updated in-place
descriptionno-Description of the processor. Useful for describing the purpose of the processor or its configuration.
ifno-Conditionally execute the processor. See Conditionally run a processor.
ignore_failurenofalseIgnore failures for the processor. See Handling pipeline failures.
on_failureno-Handle failures for the processor. See Handling pipeline failures.
tagno-Identifier for the processor. Useful for debugging and metrics.
js
{
  "join": {
    "field": "joined_array_field",
    "separator": "-"
  }
}

% NOTCONSOLE