From ef4805d85247e654552b1bb5d1f3766f783383e6 Mon Sep 17 00:00:00 2001 From: Ellie O'Neil <110510035+eboneil@users.noreply.github.com> Date: Wed, 9 Oct 2024 01:11:28 -0700 Subject: [PATCH] docs(csv-enricher): Add warning for write_semantics (#11561) --- .../src/datahub/ingestion/source/csv_enricher.py | 4 ++++ .../src/datahub/ingestion/source_config/csv_enricher.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/metadata-ingestion/src/datahub/ingestion/source/csv_enricher.py b/metadata-ingestion/src/datahub/ingestion/source/csv_enricher.py index e3f9a150ad0001..e4829f8713cf76 100644 --- a/metadata-ingestion/src/datahub/ingestion/source/csv_enricher.py +++ b/metadata-ingestion/src/datahub/ingestion/source/csv_enricher.py @@ -129,6 +129,10 @@ class CSVEnricherSource(Source): If ownership_type_urn is set then ownership_type must be set to CUSTOM. + Note that you have the option in your recipe config to write as a PATCH or as an OVERRIDE. This choice will apply to + all metadata for the entity, not just a single aspect. So OVERRIDE will override all metadata, including performing + deletes if a metadata field is empty. The default is PATCH. + :::note This source will not work on very large csv files that do not fit in memory. ::: diff --git a/metadata-ingestion/src/datahub/ingestion/source_config/csv_enricher.py b/metadata-ingestion/src/datahub/ingestion/source_config/csv_enricher.py index e62c46888ef0e8..f0f0ab95ca8119 100644 --- a/metadata-ingestion/src/datahub/ingestion/source_config/csv_enricher.py +++ b/metadata-ingestion/src/datahub/ingestion/source_config/csv_enricher.py @@ -11,7 +11,7 @@ class CSVEnricherConfig(ConfigModel): ) write_semantics: str = pydantic.Field( default="PATCH", - description='Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be "PATCH" or "OVERRIDE"', + description='Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be "PATCH" or "OVERRIDE". NOTE: this will apply to all metadata for the entity, not just a single aspect.', ) delimiter: str = pydantic.Field( default=",", description="Delimiter to use when parsing CSV"