Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Rename ingest processor supports overriding target field if exists #6988

Merged
merged 5 commits into from
Apr 25, 2024

Conversation

gaobinlong
Copy link
Contributor

@gaobinlong gaobinlong commented Apr 23, 2024

Description

In 2.14.0, we'll add a new parameter override_target for the existing rename ingest processor, we need to add the parameter in the documentation of the rename ingest processor.

Issues Resolved

Closes #6949

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: gaobinlong <gbinlong@amazon.com>
Doc review complete. 
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc review complete

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gaobinlong @vagimeli Just one comment. Thanks!

@@ -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 the behavior when `target_field` already exists in the document. If set to `true`, the processor overwrites the existing `target_field` value with the new value. Default is `false`. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we clarify the type of behavior ("X behavior") or use something like "method used"?

Copy link
Contributor

@vagimeli vagimeli Apr 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised to read: 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.

@hdhalter hdhalter added 5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes labels Apr 23, 2024
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
@vagimeli vagimeli removed the 5 - Editorial review PR: Editorial review in progress label Apr 25, 2024
@vagimeli vagimeli merged commit 06f7183 into opensearch-project:main Apr 25, 2024
5 checks passed
@hdhalter hdhalter added the 3 - Done Issue is done/complete label Apr 30, 2024
@hdhalter hdhalter changed the title Rename ingest processor supports overriding target field if exists Add rRname ingest processor supports overriding target field if exists Apr 30, 2024
@hdhalter hdhalter changed the title Add rRname ingest processor supports overriding target field if exists Add Rename ingest processor supports overriding target field if exists Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Rename ingest processor supports overriding target field if exists
4 participants