mirror of
https://github.com/datahub-project/datahub.git
synced 2025-08-02 22:37:58 +00:00
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
### Lineage File Format
|
|
|
|
The lineage source file should be a `.yml` file with the following top-level keys:
|
|
|
|
**version**: the version of lineage file config the config conforms to. Currently, the only version released
|
|
is `1`.
|
|
|
|
**lineage**: the top level key of the lineage file containing a list of **EntityNodeConfig** objects
|
|
|
|
**EntityNodeConfig**:
|
|
|
|
- **entity**: **EntityConfig** object
|
|
- **upstream**: (optional) list of child **EntityNodeConfig** objects
|
|
|
|
**EntityConfig**:
|
|
|
|
- **name** : identifier of the entity. Typically name or guid, as used in constructing entity urn.
|
|
- **type**: type of the entity (only `dataset` is supported as of now)
|
|
- **env**: the environment of this entity. Should match the values in the
|
|
table [here](https://datahubproject.io/docs/graphql/enums/#fabrictype)
|
|
- **platform**: a valid platform like kafka, snowflake, etc..
|
|
- **platform_instance**: optional string specifying the platform instance of this entity
|
|
|
|
For example if dataset URN is `urn:li:dataset:(urn:li:dataPlatform:redshift,userdb.public.customer_table,DEV)` then **EntityConfig** will look like:
|
|
```yml
|
|
name : userdb.public.customer_table
|
|
type: dataset
|
|
env: DEV
|
|
platform: redshift
|
|
```
|
|
|
|
You can also view an example lineage file checked in [here](../../../../metadata-ingestion/examples/bootstrap_data/file_lineage.yml)
|