Skip to content

publish.md

Latest commit

 

History

History
49 lines (37 loc) · 2.27 KB

publish.md

File metadata and controls

49 lines (37 loc) · 2.27 KB

publish

Source: ds_platform_utils.metaflow.write_audit_publish.publish

Publishes data to a Snowflake table using the write-audit-publish (WAP) pattern.

Signature

publish(
    table_name: str,
    query: str | Path,
    audits: list[str | Path] | None = None,
    ctx: dict[str, Any] | None = None,
    warehouse: Literal["XS", "MED", "XL"] = None,
    use_utc: bool = True,
) -> None

What it does

  • Reads SQL from a string or .sql path.
  • Runs write/audit/publish operations through Snowflake.
  • Adds operation details and table links to the Metaflow card when available.

Parameters

Parameter Type Required Description
table_name str Yes Destination Snowflake table name for the publish operation.
query str | Path Yes SQL query text or path to SQL file that produces the table data.
audits list[str | Path] | None No Optional SQL audits (strings or file paths) executed as validation checks.
ctx dict[str, Any] | None No Optional template substitution context for SQL operations.
warehouse Literal["XS", "MED", "XL"] | None No Snowflake warehouse override for this operation. Supports XS/MED/XL shortcuts or a full warehouse name.
use_utc bool No If True, uses UTC timezone for Snowflake session.

Returns: None

Typical usage

from ds_platform_utils.metaflow import publish

publish(
    table_name="MY_TABLE",
    query="SELECT * FROM PATTERN_DB.{{schema}}.SOURCE",
    audits=["SELECT COUNT(*) > 0 FROM PATTERN_DB.{{schema}}.{{table_name}}"],
)