wiring.check_results()

Yield a result for each check check_specs declares, without writing any rows.

Usage

Source

wiring.check_results(
    schema,
    frame,
    *,
    asset_key,
    severity,
    check_granularity=None,
    schema_rules=None,
    max_failure_samples=None
)

Parameters

severity: dg.AssetCheckSeverity

The severity of every failing check except the column-schema check, which is always ERROR.

check_granularity: Granularity | None = None

Pass the value check_specs received, or the results name checks the asset does not declare. None uses DAGSTER_DATAFRAMELY_CHECK_GRANULARITY if set, else rule.

schema_rules: SchemaRules | None = None

Pass the value check_specs received, as for check_granularity. None uses DAGSTER_DATAFRAMELY_SCHEMA_RULES if set, else collapsed.

max_failure_samples: int | None = None

A rule’s check metadata has at most this many rows that failed it. None uses DAGSTER_DATAFRAMELY_MAX_FAILURE_SAMPLES if set, else 5.

Yields

The column-schema check’s result, then one result per rule set, in the order of check_specs.

Raises

InvalidSettingError

A setting’s argument or environment variable has a value the setting does not allow.

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.

ColumnSchemaError

The frame’s columns or dtypes do not match the schema. It yields the column-schema check’s failing result first.