Rename ingest processor supports overriding target field if exists (#…

…6988) * Rename ingest processor supports overriding target field if exists Signed-off-by: gaobinlong <[email protected]> * Update rename.md Doc review complete. Signed-off-by: Melissa Vagi <[email protected]> * Update rename.md Signed-off-by: Melissa Vagi <[email protected]> * Update rename.md Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: gaobinlong <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]>
opensearch-project · Apr 25, 2024 · 06f7183 · 06f7183
1 parent 51e3725
commit 06f7183
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/_ingest-pipelines/processors/rename.md b/_ingest-pipelines/processors/rename.md
@@ -34,6 +34,7 @@ The following table lists the required and optional parameters for the `rename`
 `field`  | Required  | The field name containing the data to be removed. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). |
 `target_field`  | Required  | The new name of the field. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). |
 `ignore_missing`  | Optional  | Specifies whether the processor should ignore documents that do not contain the specified `field`. If set to `true`, the processor does not modify the document if the `field` does not exist. Default is `false`. |
+`override_target`  | Optional  | Determines what happens when `target_field` exists in the document. If set to `true`, the processor overwrites the existing `target_field` value with the new value. If set to `false`, the existing value remains and the processor does not overwrite it. Default is `false`. |
 `description`  | Optional  | A brief description of the processor.  |
 `if` | Optional | A condition for running the processor. |
 `ignore_failure` | Optional | Specifies whether the processor continues execution even if it encounters an error. If set to `true`, failures are ignored. Default is `false`. |