docs(csv-enricher): Add warning for write_semantics (datahub-project#…

…11561)
mayurinehate · Oct 9, 2024 · ef4805d · ef4805d
1 parent 732543f
commit ef4805d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git 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
@@ -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"