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

Remove ingest processor supports excluding fields #6244

Merged
merged 6 commits into from
Jan 26, 2024

Conversation

gaobinlong
Copy link
Contributor

@gaobinlong gaobinlong commented Jan 23, 2024

Description

The remove ingest processor will support excluding fields in version 2.12.0, a new parameter exclude_filed is added to that processor, this PR updates the remove processor's document to add the parameter.

Issues Resolved

Fixes #5918

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.

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.

@gaobinlong Please see the doc review edits. I'll move this into editorial once changes are made. Thank you!

_ingest-pipelines/processors/remove.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/remove.md Outdated Show resolved Hide resolved
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label Jan 24, 2024
@hdhalter hdhalter added release-notes PR: Include this PR in the automated release notes v2.12.0 labels Jan 24, 2024
@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 25, 2024
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.

@vagimeli Just one comment. Thanks!

@@ -30,7 +30,8 @@ The following table lists the required and optional parameters for the `remove`

| Parameter | Required/Optional | Description |
|---|---|---|
`field` | Required | The name of the field containing the data to be removed. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). The following metadata fields are not allowed to be removed: `_index`, `_version`, `_version_type`, and `_id`. Note that `_id` is not allowed to be removed when there's a specified external version for the ingesting document. |
`field` | Optional | The field name containing the data to be removed. Supports [template snippets]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/#template-snippets). The following metadata fields cannot be removed: `_index`, `_version`, `_version_type`, and `_id`. If a version is specified for the ingesting document, the `_id` cannot be removed. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

As written, "ingesting document" implies that the document is ingesting something. Is this accurate, or should we reword?

Copy link
Contributor

Choose a reason for hiding this comment

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

Revised: The metadata fields _index, _version, _version_type, and _idcannot be removed. Ifversionis specified,_id cannot be removed from the ingested document.

@vagimeli vagimeli added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jan 26, 2024
@vagimeli vagimeli merged commit 8eef743 into opensearch-project:main Jan 26, 2024
3 checks passed
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.12.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Remove ingest processor supports excluding fields
5 participants