Back to Elasticsearch

Rename processor [rename-processor]

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

9.4.01.8 KB
Original Source

Rename processor [rename-processor]

Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown.

$$$rename-options$$$

NameRequiredDefaultDescription
fieldyes-The field to be renamed. Supports template snippets.
target_fieldyes-The new name of the field. Supports template snippets.
ignore_missingnofalseIf true and field does not exist, the processor quietly exits without modifying the document.
overridenofalseIf true, the processor will update pre-existing non-null-valued fields. When set to false, such fields will not be touched.
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
{
  "rename": {
    "field": "provider",
    "target_field": "cloud.provider"
  }
}

% NOTCONSOLE