mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-04 15:50:14 +00:00
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
|
# Extended Properties
|
||
|
|
|
||
|
|
## Expected Capabilities
|
||
|
|
|
||
|
|
### structured_properties command
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
- id: io.acryl.privacy.retentionTime
|
||
|
|
# urn: urn:li:structuredProperty:<>
|
||
|
|
# fullyQualifiedName: io.acryl.privacy.retentionTime
|
||
|
|
type: STRING
|
||
|
|
cardinality: MULTIPLE
|
||
|
|
entityTypes:
|
||
|
|
- dataset # or urn:li:logicalEntity:metamodel.datahub.dataset
|
||
|
|
- dataflow
|
||
|
|
description: "Retention Time is used to figure out how long to retain records in a dataset"
|
||
|
|
allowedValues:
|
||
|
|
- value: 30 days
|
||
|
|
description: 30 days, usually reserved for datasets that are ephemeral and contain pii
|
||
|
|
- value: 3 months
|
||
|
|
description: Use this for datasets that drive monthly reporting but contain pii
|
||
|
|
- value: 2 yrs
|
||
|
|
description: Use this for non-sensitive data that can be retained for longer
|
||
|
|
- id: io.acryl.dataManagement.replicationSLA
|
||
|
|
type: NUMBER
|
||
|
|
description: "SLA for how long data can be delayed before replicating to the destination cluster"
|
||
|
|
entityTypes:
|
||
|
|
- dataset
|
||
|
|
- id: io.acryl.dataManagement.deprecationDate
|
||
|
|
type: DATE
|
||
|
|
entityTypes:
|
||
|
|
- dataset
|
||
|
|
- dataFlow
|
||
|
|
- dataJob
|
||
|
|
```
|
||
|
|
|
||
|
|
```
|
||
|
|
datahub properties create -f structured_properties.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
```
|
||
|
|
datahub properties create --name io.acryl.privacy.retentionTime --type STRING --cardinality MULTIPLE --entity_type DATASET --entity_type DATAFLOW
|
||
|
|
```
|
||
|
|
|
||
|
|
### dataset command
|
||
|
|
|
||
|
|
```
|
||
|
|
datahub dataset create -f dataset.yaml
|
||
|
|
```
|
||
|
|
|
||
|
|
See example in `dataproduct`.
|