Skip to content

NIFI-8498: Optional removal of fields with UpdateRecord#5121

Closed
pgyori wants to merge 1 commit intoapache:mainfrom
pgyori:NIFI-8498-4
Closed

NIFI-8498: Optional removal of fields with UpdateRecord#5121
pgyori wants to merge 1 commit intoapache:mainfrom
pgyori:NIFI-8498-4

Conversation

@pgyori
Copy link
Contributor

@pgyori pgyori commented Jun 3, 2021

https://issues.apache.org/jira/browse/NIFI-8498

Description of PR

Enables removing fields from records.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit? Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not squash or use --force when pushing to allow for clean monitoring of changes.

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
  • Have you written or updated unit tests to verify your changes?
  • Have you verified that the full build is successful on JDK 8?
  • Have you verified that the full build is successful on JDK 11?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?
  • If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.

@pgyori
Copy link
Contributor Author

pgyori commented Jun 3, 2021

UpdateRecord_field_removal.xml.zip

At this point the PR is a draft.
NiFi Record handling has been enhanced to support the removal of fields.
At this point it supports:

  • removal of fields from records
  • removal of fields from nested records (deep structures are handled)
  • removal of fields from schemas when actual data is not present in the record
  • only the handling of primitive types and type RECORD.

Not yet supported:

  • the handling of the following types: MAP, CHOICE, ARRAY, ENUM.

The way field removal is triggered will be changed. Currently in UpdateRecord, a new dynamic property needs to be added, the name of the property should be the RecordPath to the field that needs to be removed and the value should be marked empty. Also, Replacement Value Strategy needs to be set to Record Path Value.

The unit tests have not yet been pushed. Those will arrive in a future commit.

Attached a flow template that can be used for testing.

getParentRecord().get().setArrayValue(getField().getFieldName(), getArrayIndex(), newValue);
}

@Override
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you explain why this method is empty in a nested comment and/or throw an UnsupportedOperationException?

*/
void updateValue(Object newValue, DataType dataType);

void remove();
Copy link
Contributor

@Lehel44 Lehel44 Jun 16, 2021

Choose a reason for hiding this comment

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

Can you please add Javadoc here to be consistent with the other interface methods?

getParentRecord().get().setMapValue(getField().getFieldName(), getMapKey(), newValue);
}

@Override
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here.

if (parent != null) {
if (parent.getDataType() instanceof RecordDataType) {
Optional<RecordField> childFieldOptional = ((RecordDataType) parent.getDataType()).getChildSchema().getField(childName);
if (childFieldOptional.isPresent()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

If you like functional style - I like that it's more compact - this can be replaced by:

childFieldOptional.map(recordField -> missingChild(fieldValue, recordField)).orElseGet(() -> missingChild(fieldValue));

if (value == null) {
return missingChild(fieldValue);
final Optional<RecordField> childFieldOptional = record.getSchema().getField(childName);
if (childFieldOptional.isPresent()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here:

childFieldOptional.map(recordField -> missingChild(fieldValue, recordField)).orElseGet(() -> missingChild(fieldValue));


for (RecordField schemaField : schema.getFields()) {
Object fieldValue = getValue(schemaField);
if (fieldValue != null && fieldValue instanceof Record) {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the null check here is not necessary, instanceof returns false for nulls.

if (replacementRecordPath.isAbsolute()) {
record = processAbsolutePath(replacementRecordPath, result.getSelectedFields(), record);
} else {
record = processRelativePath(replacementRecordPath, result.getSelectedFields(), record);
Copy link
Contributor

@Lehel44 Lehel44 Jun 16, 2021

Choose a reason for hiding this comment

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

I don't think the assignment here is necessary. processRelativePath returns the record passed in the argument. The method can be void. Can it be?

@pgyori
Copy link
Contributor Author

pgyori commented Oct 1, 2021

Closing this PR as I eventually implemented this functionality in #5381

@pgyori pgyori closed this Oct 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants