diff --git a/docs/docs-beta/docs/guides/data-modeling/metadata.md b/docs/docs-beta/docs/guides/data-modeling/metadata.md index 988e3c0c2f4cf..8a9265df831d5 100644 --- a/docs/docs-beta/docs/guides/data-modeling/metadata.md +++ b/docs/docs-beta/docs/guides/data-modeling/metadata.md @@ -54,7 +54,7 @@ Here's an example of some tags you might apply to an asset: {"domain": "marketing", "pii": "true"} ``` -**Metadata** allows you to attach rich information to the asset, like a Markdown description, a table schema, or a time series. Metadata is more flexible than tags, as it can store more complex information. Metadata can be attached to an asset at definition time (i.e. when the code is first imported) or at runtime (every time an asset is materialized). +**Metadata** allows you to attach rich information to the asset, like a Markdown description, a table schema, or a time series. Metadata is more flexible than tags, as it can store more complex information. Metadata can be attached to an asset at definition time (that is, when the code is first imported) or at runtime (every time an asset is materialized). Here's an example of some metadata you might apply to an asset: @@ -96,19 +96,19 @@ Any numerical metadata will be treated as a time series in the Dagster UI. Some metadata keys will be given special treatment in the Dagster UI. -| Key | Description | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `dagster/uri` | **Type:** `str`

The URI for the asset, e.g. "s3://my_bucket/my_object" | -| `dagster/column_schema` | **Type:** [`TableSchema`](/todo)

For an asset that's a table, the schema of the columns in the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. | -| `dagster/column_lineage` | **Type:** [`TableColumnLineage`](/todo)

For an asset that's a table, the lineage of column inputs to column outputs for the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. | -| `dagster/row_count` | **Type:** `int`

For an asset that's a table, the number of rows in the table. Refer to the Table metadata documentation for details. | -| `dagster/partition_row_count` | **Type:** `int`

For a partition of an asset that's a table, the number of rows in the partition. | -| `dagster/relation_identifier` | **Type:** `str`

A unique identifier for the table/view, typically fully qualified. For example, my_database.my_schema.my_table | -| `dagster/code_references` | **Type:** [`CodeReferencesMetadataValue`](/todo)

A list of code references for the asset, such as file locations or references to GitHub URLs. Refer to the [Linking assets with their source code](#linking-your-assets-with-their-source-code) section for details. Should only be provided in definition-level metadata, not materialization metadata. | +| Key | Description | +| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `dagster/uri` | **Type:** `str`

The URI for the asset, e.g. "s3://my_bucket/my_object" | +| `dagster/column_schema` | **Type:** [`TableSchema`](/todo)

For an asset that's a table, the schema of the columns in the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. | +| `dagster/column_lineage` | **Type:** [`TableColumnLineage`](/todo)

For an asset that's a table, the lineage of column inputs to column outputs for the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. | +| `dagster/row_count` | **Type:** `int`

For an asset that's a table, the number of rows in the table. Refer to the Table metadata documentation for details. | +| `dagster/partition_row_count` | **Type:** `int`

For a partition of an asset that's a table, the number of rows in the partition. | +| `dagster/relation_identifier` | **Type:** `str`

A unique identifier for the table/view, typically fully qualified. For example, my_database.my_schema.my_table | +| `dagster/code_references` | **Type:** [`CodeReferencesMetadataValue`](/todo)

A list of code references for the asset, such as file locations or references to GitHub URLs. Refer to the [Linking assets with their source code](#linking-assets-with-their-source-code) section for details. Should only be provided in definition-level metadata, not materialization metadata. | ## Table and column metadata -Two of the most powerful metadata types are [`TableSchema`](/todo) and [`TableColumnLineage`](/todo). These metadata types allow stakeholders to view the schema of a table right within Dagster, and, in Dagster+, navigate the [asset catalog](/todo) via the column lineage. +Two of the most powerful metadata types are [`TableSchema`](/todo) and [`TableColumnLineage`](/todo). These metadata types allow stakeholders to view the schema of a table right within Dagster, and, in Dagster+, navigate the [Asset catalog](/todo) via the column lineage. ### Table schema metadata @@ -132,7 +132,7 @@ Column lineage metadata is a powerful way to track how columns in a table are de :::tip -Dagster+ provides rich visualization and navigation of column lineage in the asset catalog. Refer to the [Dagster+ documentation](/dagster-plus) for more information. +Dagster+ provides rich visualization and navigation of column lineage in the Asset catalog. Refer to the [Dagster+ documentation](/dagster-plus) for more information. :::