Skip to content

Commit ef4805d

Browse files
authored
docs(csv-enricher): Add warning for write_semantics (datahub-project#11561)
1 parent 732543f commit ef4805d

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

metadata-ingestion/src/datahub/ingestion/source/csv_enricher.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,10 @@ class CSVEnricherSource(Source):
129129
130130
If ownership_type_urn is set then ownership_type must be set to CUSTOM.
131131
132+
Note that you have the option in your recipe config to write as a PATCH or as an OVERRIDE. This choice will apply to
133+
all metadata for the entity, not just a single aspect. So OVERRIDE will override all metadata, including performing
134+
deletes if a metadata field is empty. The default is PATCH.
135+
132136
:::note
133137
This source will not work on very large csv files that do not fit in memory.
134138
:::

metadata-ingestion/src/datahub/ingestion/source_config/csv_enricher.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class CSVEnricherConfig(ConfigModel):
1111
)
1212
write_semantics: str = pydantic.Field(
1313
default="PATCH",
14-
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"',
14+
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.',
1515
)
1616
delimiter: str = pydantic.Field(
1717
default=",", description="Delimiter to use when parsing CSV"

0 commit comments

Comments
 (0)