wiring.get_column_schema_metadata()

Return the metadata that fills an asset’s Columns tab from the schema.

Usage

Source

wiring.get_column_schema_metadata(schema)

Parameters

schema: type[dy.Schema]

The schema to render.

Returns

dict[str, dg.TableSchema]

A one-entry mapping from dagster/column_schema to get_table_schema(schema), to pass to dg.asset(metadata=...) and, in a run, to context.add_asset_metadata.

Raises

ReservedColumnError

A column name is in the reserved dy_ namespace.

InvalidColumnNameError

A column name has a character Dagster does not allow in an asset check name.

CheckNameCollisionError

Two rules produce the same asset check name.

InvalidSeverityError

The schema declares a severity this package cannot read.

Examples

import dagster as dg
import polars as pl

import dagster_dataframely as dd
from dagster_dataframely.data import OrdersSchema


@dg.asset(metadata=dd.wiring.get_column_schema_metadata(OrdersSchema))
def orders(raw_orders: pl.DataFrame) -> pl.DataFrame:
    return raw_orders


list(orders.metadata_by_key[orders.key])

['dagster/column_schema']