Skip to content

feat: add YML and MD documentation for all macros (#374) - #489

Merged
tkirschke merged 21 commits into
mainfrom
feat/374-macro-yml-documentation
Aug 5, 2026
Merged

feat: add YML and MD documentation for all macros (#374)#489
tkirschke merged 21 commits into
mainfrom
feat/374-macro-yml-documentation

Conversation

@pkumar-data

Copy link
Copy Markdown
Contributor

Add dbt schema documentation for all 19 parent macros (YML + MD with usage examples) and all 187 adapter-specific macro implementations (YML only) across 11 adapters: snowflake, bigquery, databricks, exasol, fabric, oracle, postgres, redshift, sqlserver, synapse, and trino.

Description

Please include a summary of the changes and the related issue and context.

Fixes #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.

  • Tests you ran

Test Configuration:

  • datavault4dbt-Version:
  • dbt-Version: cloud/core, version number
  • dbt-adapter-Version:

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation or included information that needs updates (e.g. in the Wiki)

Add dbt schema documentation for all 19 parent macros (YML + MD with
usage examples) and all 187 adapter-specific macro implementations
(YML only) across 11 adapters: snowflake, bigquery, databricks, exasol,
fabric, oracle, postgres, redshift, sqlserver, synapse, and trino.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds dbt “schema.yml”-style macro documentation and companion Markdown docs for the package’s macro surface area, including adapter-dispatched implementations across supported warehouses.

Changes:

  • Added Markdown docs ({% docs ... %}) with usage examples for the parent/entrypoint macros.
  • Added version: 2 YAML schema documentation for the parent macros and for each adapter-specific adapter.dispatch() implementation.
  • Added schema + Markdown documentation for the clean_up_pit post-hook macro.

Reviewed changes

Copilot reviewed 225 out of 225 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
macros/hooks/clean_up_pit.md Adds usage documentation for the clean_up_pit post-hook macro.
macros/hooks/clean_up_pit.yml Adds schema documentation for the clean_up_pit macro arguments.
macros/tables/control_snap_v0.md Adds usage documentation for control_snap_v0.
macros/tables/control_snap_v0.yml Adds schema documentation for control_snap_v0 arguments.
macros/tables/control_snap_v1.md Adds usage documentation for control_snap_v1.
macros/tables/control_snap_v1.yml Adds schema documentation for control_snap_v1 arguments.
macros/tables/eff_sat_v0.md Adds usage documentation for eff_sat_v0.
macros/tables/eff_sat_v0.yml Adds schema documentation for eff_sat_v0 arguments.
macros/tables/hub.md Adds usage documentation for hub.
macros/tables/hub.yml Adds schema documentation for hub arguments.
macros/tables/link.md Adds usage documentation for link.
macros/tables/link.yml Adds schema documentation for link arguments.
macros/tables/ma_sat_v0.md Adds usage documentation for ma_sat_v0.
macros/tables/ma_sat_v0.yml Adds schema documentation for ma_sat_v0 arguments.
macros/tables/ma_sat_v1.md Adds usage documentation for ma_sat_v1.
macros/tables/ma_sat_v1.yml Adds schema documentation for ma_sat_v1 arguments.
macros/tables/nh_link.md Adds usage documentation for nh_link.
macros/tables/nh_link.yml Adds schema documentation for nh_link arguments.
macros/tables/nh_sat.md Adds usage documentation for nh_sat.
macros/tables/nh_sat.yml Adds schema documentation for nh_sat arguments.
macros/tables/pit.md Adds usage documentation for pit.
macros/tables/pit.yml Adds schema documentation for pit arguments.
macros/tables/rec_track_sat.md Adds usage documentation for rec_track_sat.
macros/tables/rec_track_sat.yml Adds schema documentation for rec_track_sat arguments.
macros/tables/ref_hub.md Adds usage documentation for ref_hub.
macros/tables/ref_hub.yml Adds schema documentation for ref_hub arguments.
macros/tables/ref_sat_v0.md Adds usage documentation for ref_sat_v0.
macros/tables/ref_sat_v0.yml Adds schema documentation for ref_sat_v0 arguments.
macros/tables/ref_sat_v1.md Adds usage documentation for ref_sat_v1.
macros/tables/ref_sat_v1.yml Adds schema documentation for ref_sat_v1 arguments.
macros/tables/ref_table.md Adds usage documentation for ref_table.
macros/tables/ref_table.yml Adds schema documentation for ref_table arguments.
macros/tables/sat_v0.md Adds usage documentation for sat_v0.
macros/tables/sat_v0.yml Adds schema documentation for sat_v0 arguments.
macros/tables/sat_v1.md Adds usage documentation for sat_v1.
macros/tables/sat_v1.yml Adds schema documentation for sat_v1 arguments.
macros/tables/bigquery/control_snap_v0.yml Adds BigQuery adapter schema docs for control_snap_v0.
macros/tables/bigquery/control_snap_v1.yml Adds BigQuery adapter schema docs for control_snap_v1.
macros/tables/bigquery/eff_sat_v0.yml Adds BigQuery adapter schema docs for eff_sat_v0.
macros/tables/bigquery/hub.yml Adds BigQuery adapter schema docs for hub.
macros/tables/bigquery/link.yml Adds BigQuery adapter schema docs for link.
macros/tables/bigquery/ma_sat_v0.yml Adds BigQuery adapter schema docs for ma_sat_v0.
macros/tables/bigquery/ma_sat_v1.yml Adds BigQuery adapter schema docs for ma_sat_v1.
macros/tables/bigquery/nh_link.yml Adds BigQuery adapter schema docs for nh_link.
macros/tables/bigquery/nh_sat.yml Adds BigQuery adapter schema docs for nh_sat.
macros/tables/bigquery/pit.yml Adds BigQuery adapter schema docs for pit.
macros/tables/bigquery/rec_track_sat.yml Adds BigQuery adapter schema docs for rec_track_sat.
macros/tables/bigquery/ref_hub.yml Adds BigQuery adapter schema docs for ref_hub.
macros/tables/bigquery/ref_sat_v0.yml Adds BigQuery adapter schema docs for ref_sat_v0.
macros/tables/bigquery/ref_sat_v1.yml Adds BigQuery adapter schema docs for ref_sat_v1.
macros/tables/bigquery/ref_table.yml Adds BigQuery adapter schema docs for ref_table.
macros/tables/bigquery/sat_v0.yml Adds BigQuery adapter schema docs for sat_v0.
macros/tables/bigquery/sat_v1.yml Adds BigQuery adapter schema docs for sat_v1.
macros/tables/databricks/control_snap_v0.yml Adds Databricks adapter schema docs for control_snap_v0.
macros/tables/databricks/control_snap_v1.yml Adds Databricks adapter schema docs for control_snap_v1.
macros/tables/databricks/eff_sat_v0.yml Adds Databricks adapter schema docs for eff_sat_v0.
macros/tables/databricks/hub.yml Adds Databricks adapter schema docs for hub.
macros/tables/databricks/link.yml Adds Databricks adapter schema docs for link.
macros/tables/databricks/ma_sat_v0.yml Adds Databricks adapter schema docs for ma_sat_v0.
macros/tables/databricks/ma_sat_v1.yml Adds Databricks adapter schema docs for ma_sat_v1.
macros/tables/databricks/nh_link.yml Adds Databricks adapter schema docs for nh_link.
macros/tables/databricks/nh_sat.yml Adds Databricks adapter schema docs for nh_sat.
macros/tables/databricks/pit.yml Adds Databricks adapter schema docs for pit.
macros/tables/databricks/rec_track_sat.yml Adds Databricks adapter schema docs for rec_track_sat.
macros/tables/databricks/ref_hub.yml Adds Databricks adapter schema docs for ref_hub.
macros/tables/databricks/ref_sat_v0.yml Adds Databricks adapter schema docs for ref_sat_v0.
macros/tables/databricks/ref_sat_v1.yml Adds Databricks adapter schema docs for ref_sat_v1.
macros/tables/databricks/ref_table.yml Adds Databricks adapter schema docs for ref_table.
macros/tables/databricks/sat_v0.yml Adds Databricks adapter schema docs for sat_v0.
macros/tables/databricks/sat_v1.yml Adds Databricks adapter schema docs for sat_v1.
macros/tables/exasol/control_snap_v0.yml Adds Exasol adapter schema docs for control_snap_v0.
macros/tables/exasol/control_snap_v1.yml Adds Exasol adapter schema docs for control_snap_v1.
macros/tables/exasol/eff_sat_v0.yml Adds Exasol adapter schema docs for eff_sat_v0.
macros/tables/exasol/hub.yml Adds Exasol adapter schema docs for hub.
macros/tables/exasol/link.yml Adds Exasol adapter schema docs for link.
macros/tables/exasol/ma_sat_v0.yml Adds Exasol adapter schema docs for ma_sat_v0.
macros/tables/exasol/ma_sat_v1.yml Adds Exasol adapter schema docs for ma_sat_v1.
macros/tables/exasol/nh_link.yml Adds Exasol adapter schema docs for nh_link.
macros/tables/exasol/nh_sat.yml Adds Exasol adapter schema docs for nh_sat.
macros/tables/exasol/pit.yml Adds Exasol adapter schema docs for pit.
macros/tables/exasol/rec_track_sat.yml Adds Exasol adapter schema docs for rec_track_sat.
macros/tables/exasol/ref_hub.yml Adds Exasol adapter schema docs for ref_hub.
macros/tables/exasol/ref_sat_v0.yml Adds Exasol adapter schema docs for ref_sat_v0.
macros/tables/exasol/ref_sat_v1.yml Adds Exasol adapter schema docs for ref_sat_v1.
macros/tables/exasol/ref_table.yml Adds Exasol adapter schema docs for ref_table.
macros/tables/exasol/sat_v0.yml Adds Exasol adapter schema docs for sat_v0.
macros/tables/exasol/sat_v1.yml Adds Exasol adapter schema docs for sat_v1.
macros/tables/fabric/control_snap_v0.yml Adds Fabric adapter schema docs for control_snap_v0.
macros/tables/fabric/control_snap_v1.yml Adds Fabric adapter schema docs for control_snap_v1.
macros/tables/fabric/eff_sat_v0.yml Adds Fabric adapter schema docs for eff_sat_v0.
macros/tables/fabric/hub.yml Adds Fabric adapter schema docs for hub.
macros/tables/fabric/link.yml Adds Fabric adapter schema docs for link.
macros/tables/fabric/ma_sat_v0.yml Adds Fabric adapter schema docs for ma_sat_v0.
macros/tables/fabric/ma_sat_v1.yml Adds Fabric adapter schema docs for ma_sat_v1.
macros/tables/fabric/nh_link.yml Adds Fabric adapter schema docs for nh_link.
macros/tables/fabric/nh_sat.yml Adds Fabric adapter schema docs for nh_sat.
macros/tables/fabric/pit.yml Adds Fabric adapter schema docs for pit.
macros/tables/fabric/rec_track_sat.yml Adds Fabric adapter schema docs for rec_track_sat.
macros/tables/fabric/ref_hub.yml Adds Fabric adapter schema docs for ref_hub.
macros/tables/fabric/ref_sat_v0.yml Adds Fabric adapter schema docs for ref_sat_v0.
macros/tables/fabric/ref_sat_v1.yml Adds Fabric adapter schema docs for ref_sat_v1.
macros/tables/fabric/ref_table.yml Adds Fabric adapter schema docs for ref_table.
macros/tables/fabric/sat_v0.yml Adds Fabric adapter schema docs for sat_v0.
macros/tables/fabric/sat_v1.yml Adds Fabric adapter schema docs for sat_v1.
macros/tables/oracle/control_snap_v0.yml Adds Oracle adapter schema docs for control_snap_v0.
macros/tables/oracle/control_snap_v1.yml Adds Oracle adapter schema docs for control_snap_v1.
macros/tables/oracle/eff_sat_v0.yml Adds Oracle adapter schema docs for eff_sat_v0.
macros/tables/oracle/hub.yml Adds Oracle adapter schema docs for hub.
macros/tables/oracle/link.yml Adds Oracle adapter schema docs for link.
macros/tables/oracle/ma_sat_v0.yml Adds Oracle adapter schema docs for ma_sat_v0.
macros/tables/oracle/ma_sat_v1.yml Adds Oracle adapter schema docs for ma_sat_v1.
macros/tables/oracle/nh_link.yml Adds Oracle adapter schema docs for nh_link.
macros/tables/oracle/nh_sat.yml Adds Oracle adapter schema docs for nh_sat.
macros/tables/oracle/pit.yml Adds Oracle adapter schema docs for pit.
macros/tables/oracle/rec_track_sat.yml Adds Oracle adapter schema docs for rec_track_sat.
macros/tables/oracle/ref_hub.yml Adds Oracle adapter schema docs for ref_hub.
macros/tables/oracle/ref_sat_v0.yml Adds Oracle adapter schema docs for ref_sat_v0.
macros/tables/oracle/ref_sat_v1.yml Adds Oracle adapter schema docs for ref_sat_v1.
macros/tables/oracle/ref_table.yml Adds Oracle adapter schema docs for ref_table.
macros/tables/oracle/sat_v0.yml Adds Oracle adapter schema docs for sat_v0.
macros/tables/oracle/sat_v1.yml Adds Oracle adapter schema docs for sat_v1.
macros/tables/postgres/control_snap_v0.yml Adds Postgres adapter schema docs for control_snap_v0.
macros/tables/postgres/control_snap_v1.yml Adds Postgres adapter schema docs for control_snap_v1.
macros/tables/postgres/eff_sat_v0.yml Adds Postgres adapter schema docs for eff_sat_v0.
macros/tables/postgres/hub.yml Adds Postgres adapter schema docs for hub.
macros/tables/postgres/link.yml Adds Postgres adapter schema docs for link.
macros/tables/postgres/ma_sat_v0.yml Adds Postgres adapter schema docs for ma_sat_v0.
macros/tables/postgres/ma_sat_v1.yml Adds Postgres adapter schema docs for ma_sat_v1.
macros/tables/postgres/nh_link.yml Adds Postgres adapter schema docs for nh_link.
macros/tables/postgres/nh_sat.yml Adds Postgres adapter schema docs for nh_sat.
macros/tables/postgres/pit.yml Adds Postgres adapter schema docs for pit.
macros/tables/postgres/rec_track_sat.yml Adds Postgres adapter schema docs for rec_track_sat.
macros/tables/postgres/ref_hub.yml Adds Postgres adapter schema docs for ref_hub.
macros/tables/postgres/ref_sat_v0.yml Adds Postgres adapter schema docs for ref_sat_v0.
macros/tables/postgres/ref_sat_v1.yml Adds Postgres adapter schema docs for ref_sat_v1.
macros/tables/postgres/ref_table.yml Adds Postgres adapter schema docs for ref_table.
macros/tables/postgres/sat_v0.yml Adds Postgres adapter schema docs for sat_v0.
macros/tables/postgres/sat_v1.yml Adds Postgres adapter schema docs for sat_v1.
macros/tables/redshift/control_snap_v0.yml Adds Redshift adapter schema docs for control_snap_v0.
macros/tables/redshift/control_snap_v1.yml Adds Redshift adapter schema docs for control_snap_v1.
macros/tables/redshift/eff_sat_v0.yml Adds Redshift adapter schema docs for eff_sat_v0.
macros/tables/redshift/hub.yml Adds Redshift adapter schema docs for hub.
macros/tables/redshift/link.yml Adds Redshift adapter schema docs for link.
macros/tables/redshift/ma_sat_v0.yml Adds Redshift adapter schema docs for ma_sat_v0.
macros/tables/redshift/ma_sat_v1.yml Adds Redshift adapter schema docs for ma_sat_v1.
macros/tables/redshift/nh_link.yml Adds Redshift adapter schema docs for nh_link.
macros/tables/redshift/nh_sat.yml Adds Redshift adapter schema docs for nh_sat.
macros/tables/redshift/pit.yml Adds Redshift adapter schema docs for pit.
macros/tables/redshift/rec_track_sat.yml Adds Redshift adapter schema docs for rec_track_sat.
macros/tables/redshift/ref_hub.yml Adds Redshift adapter schema docs for ref_hub.
macros/tables/redshift/ref_sat_v0.yml Adds Redshift adapter schema docs for ref_sat_v0.
macros/tables/redshift/ref_sat_v1.yml Adds Redshift adapter schema docs for ref_sat_v1.
macros/tables/redshift/ref_table.yml Adds Redshift adapter schema docs for ref_table.
macros/tables/redshift/sat_v0.yml Adds Redshift adapter schema docs for sat_v0.
macros/tables/redshift/sat_v1.yml Adds Redshift adapter schema docs for sat_v1.
macros/tables/snowflake/control_snap_v0.yml Adds Snowflake adapter schema docs for control_snap_v0.
macros/tables/snowflake/control_snap_v1.yml Adds Snowflake adapter schema docs for control_snap_v1.
macros/tables/snowflake/eff_sat_v0.yml Adds Snowflake adapter schema docs for eff_sat_v0.
macros/tables/snowflake/hub.yml Adds Snowflake adapter schema docs for hub.
macros/tables/snowflake/link.yml Adds Snowflake adapter schema docs for link.
macros/tables/snowflake/ma_sat_v0.yml Adds Snowflake adapter schema docs for ma_sat_v0.
macros/tables/snowflake/ma_sat_v1.yml Adds Snowflake adapter schema docs for ma_sat_v1.
macros/tables/snowflake/nh_link.yml Adds Snowflake adapter schema docs for nh_link.
macros/tables/snowflake/nh_sat.yml Adds Snowflake adapter schema docs for nh_sat.
macros/tables/snowflake/pit.yml Adds Snowflake adapter schema docs for pit.
macros/tables/snowflake/rec_track_sat.yml Adds Snowflake adapter schema docs for rec_track_sat.
macros/tables/snowflake/ref_hub.yml Adds Snowflake adapter schema docs for ref_hub.
macros/tables/snowflake/ref_sat_v0.yml Adds Snowflake adapter schema docs for ref_sat_v0.
macros/tables/snowflake/ref_sat_v1.yml Adds Snowflake adapter schema docs for ref_sat_v1.
macros/tables/snowflake/ref_table.yml Adds Snowflake adapter schema docs for ref_table.
macros/tables/snowflake/sat_v0.yml Adds Snowflake adapter schema docs for sat_v0.
macros/tables/snowflake/sat_v1.yml Adds Snowflake adapter schema docs for sat_v1.
macros/tables/sqlserver/control_snap_v0.yml Adds SQL Server adapter schema docs for control_snap_v0.
macros/tables/sqlserver/control_snap_v1.yml Adds SQL Server adapter schema docs for control_snap_v1.
macros/tables/sqlserver/eff_sat_v0.yml Adds SQL Server adapter schema docs for eff_sat_v0.
macros/tables/sqlserver/hub.yml Adds SQL Server adapter schema docs for hub.
macros/tables/sqlserver/link.yml Adds SQL Server adapter schema docs for link.
macros/tables/sqlserver/ma_sat_v0.yml Adds SQL Server adapter schema docs for ma_sat_v0.
macros/tables/sqlserver/ma_sat_v1.yml Adds SQL Server adapter schema docs for ma_sat_v1.
macros/tables/sqlserver/nh_link.yml Adds SQL Server adapter schema docs for nh_link.
macros/tables/sqlserver/nh_sat.yml Adds SQL Server adapter schema docs for nh_sat.
macros/tables/sqlserver/pit.yml Adds SQL Server adapter schema docs for pit.
macros/tables/sqlserver/rec_track_sat.yml Adds SQL Server adapter schema docs for rec_track_sat.
macros/tables/sqlserver/ref_hub.yml Adds SQL Server adapter schema docs for ref_hub.
macros/tables/sqlserver/ref_sat_v0.yml Adds SQL Server adapter schema docs for ref_sat_v0.
macros/tables/sqlserver/ref_sat_v1.yml Adds SQL Server adapter schema docs for ref_sat_v1.
macros/tables/sqlserver/ref_table.yml Adds SQL Server adapter schema docs for ref_table.
macros/tables/sqlserver/sat_v0.yml Adds SQL Server adapter schema docs for sat_v0.
macros/tables/sqlserver/sat_v1.yml Adds SQL Server adapter schema docs for sat_v1.
macros/tables/synapse/control_snap_v0.yml Adds Synapse adapter schema docs for control_snap_v0.
macros/tables/synapse/control_snap_v1.yml Adds Synapse adapter schema docs for control_snap_v1.
macros/tables/synapse/eff_sat_v0.yml Adds Synapse adapter schema docs for eff_sat_v0.
macros/tables/synapse/hub.yml Adds Synapse adapter schema docs for hub.
macros/tables/synapse/link.yml Adds Synapse adapter schema docs for link.
macros/tables/synapse/ma_sat_v0.yml Adds Synapse adapter schema docs for ma_sat_v0.
macros/tables/synapse/ma_sat_v1.yml Adds Synapse adapter schema docs for ma_sat_v1.
macros/tables/synapse/nh_link.yml Adds Synapse adapter schema docs for nh_link.
macros/tables/synapse/nh_sat.yml Adds Synapse adapter schema docs for nh_sat.
macros/tables/synapse/pit.yml Adds Synapse adapter schema docs for pit.
macros/tables/synapse/rec_track_sat.yml Adds Synapse adapter schema docs for rec_track_sat.
macros/tables/synapse/ref_hub.yml Adds Synapse adapter schema docs for ref_hub.
macros/tables/synapse/ref_sat_v0.yml Adds Synapse adapter schema docs for ref_sat_v0.
macros/tables/synapse/ref_sat_v1.yml Adds Synapse adapter schema docs for ref_sat_v1.
macros/tables/synapse/ref_table.yml Adds Synapse adapter schema docs for ref_table.
macros/tables/synapse/sat_v0.yml Adds Synapse adapter schema docs for sat_v0.
macros/tables/synapse/sat_v1.yml Adds Synapse adapter schema docs for sat_v1.
macros/tables/trino/control_snap_v0.yml Adds Trino adapter schema docs for control_snap_v0.
macros/tables/trino/control_snap_v1.yml Adds Trino adapter schema docs for control_snap_v1.
macros/tables/trino/eff_sat_v0.yml Adds Trino adapter schema docs for eff_sat_v0.
macros/tables/trino/hub.yml Adds Trino adapter schema docs for hub.
macros/tables/trino/link.yml Adds Trino adapter schema docs for link.
macros/tables/trino/ma_sat_v0.yml Adds Trino adapter schema docs for ma_sat_v0.
macros/tables/trino/ma_sat_v1.yml Adds Trino adapter schema docs for ma_sat_v1.
macros/tables/trino/nh_link.yml Adds Trino adapter schema docs for nh_link.
macros/tables/trino/nh_sat.yml Adds Trino adapter schema docs for nh_sat.
macros/tables/trino/pit.yml Adds Trino adapter schema docs for pit.
macros/tables/trino/rec_track_sat.yml Adds Trino adapter schema docs for rec_track_sat.
macros/tables/trino/ref_hub.yml Adds Trino adapter schema docs for ref_hub.
macros/tables/trino/ref_sat_v0.yml Adds Trino adapter schema docs for ref_sat_v0.
macros/tables/trino/ref_sat_v1.yml Adds Trino adapter schema docs for ref_sat_v1.
macros/tables/trino/ref_table.yml Adds Trino adapter schema docs for ref_table.
macros/tables/trino/sat_v0.yml Adds Trino adapter schema docs for sat_v0.
macros/tables/trino/sat_v1.yml Adds Trino adapter schema docs for sat_v1.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread macros/tables/ref_hub.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 225 out of 225 changed files in this pull request and generated 15 comments.

Comment thread macros/tables/bigquery/hub.yml Outdated
Comment thread macros/tables/bigquery/link.yml Outdated
Comment thread macros/tables/bigquery/sat_v0.yml Outdated
Comment thread macros/tables/bigquery/sat_v1.yml Outdated
Comment thread macros/tables/bigquery/eff_sat_v0.yml Outdated
Comment thread macros/tables/bigquery/nh_sat.yml Outdated
Comment thread macros/tables/bigquery/nh_link.yml Outdated
Comment thread macros/tables/bigquery/ma_sat_v0.yml Outdated
Comment thread macros/tables/bigquery/ma_sat_v1.yml Outdated
Comment thread macros/tables/bigquery/control_snap_v0.yml Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 225 out of 225 changed files in this pull request and generated no new comments.

tkiehn
tkiehn previously requested changes Jul 13, 2026

@tkiehn tkiehn left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread macros/staging/stage.md
Comment thread macros/staging/stage.md
Comment thread macros/tables/bigquery/control_snap_v0.yml Outdated
Comment thread macros/tables/bigquery/control_snap_v0.yml Outdated
Comment thread macros/tables/bigquery/control_snap_v0.yml Outdated
@tkiehn tkiehn added the waiting-on-response Waiting on a response from the author or others, except maintainers. label Jul 13, 2026
Move all adapter-specific YML documentation entries (snowflake__, databricks__,
exasol__, fabric__, oracle__, postgres__, redshift__, sqlserver__, synapse__,
trino__, default__/bigquery__) into their respective parent macro YML files
instead of maintaining separate YML files per adapter per macro.

Fix all invalid dbt argument types across parent macro YMLs:
dictionary → dict, list of strings → list,
string | list of strings → Any, list | string → Any,
timestamp → string, time → string, 'all' | 'distinct' → string

Removes 187 separate adapter YML files.
Add Jinja set block examples to the Metadata block usage section of all
18 macro doc files (17 table macros + stage), explaining what meta is
and how it is defined. The stage.md example also demonstrates derived_columns
in YAML syntax as required.

Fix stage.yml argument types: dictionary -> dict, boolean -> bool,
string | dictionary -> Any.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 21 comments.

Comment thread macros/tables/sat_v1.yml
Comment thread macros/tables/sat_v0.yml
Comment thread macros/tables/ref_table.yml
Comment thread macros/tables/ref_sat_v1.yml
Comment thread macros/tables/ref_sat_v0.yml
Comment thread macros/tables/control_snap_v0.yml
Comment thread macros/staging/stage.yml
Comment thread macros/tables/sat_v1.yml Outdated
Comment thread macros/tables/ref_sat_v1.yml Outdated
Comment thread macros/tables/ma_sat_v1.yml Outdated
pkumar-data and others added 2 commits July 14, 2026 10:46
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
… files

yaml_metadata is parsed with fromyaml() and expects a YAML-formatted string,
not a dict. Updated type and description across all 17 table macro YMLs and stage.yml.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 4 comments.

Comment thread macros/tables/sat_v1.yml Outdated
Comment thread macros/tables/ref_sat_v1.yml Outdated
Comment thread macros/tables/ma_sat_v1.yml Outdated
Comment thread macros/tables/hub.md Outdated
Fix inverted wording in ledts_alias description across sat_v1.yml,
ma_sat_v1.yml, and ref_sat_v1.yml: the global variable is used when
the parameter is NOT provided, not when it is set.

Fix hub.md metadata block example: business_keys was inconsistently
defined as a 2-item list while bk_columns used a single value. Both
now use a single value, consistent with the Usage section.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated no new comments.

Documents internal/helpers, internal/metadata_processing, supporting,
hooks, and rehashing/internal_overwrites macro folders.
@pkumar-data pkumar-data added waiting-on-maintainers Waiting for a response from the maintainers. and removed waiting-on-response Waiting on a response from the author or others, except maintainers. labels Jul 16, 2026
@ScalefreeCOM ScalefreeCOM deleted a comment from remoteworkflow Bot Jul 16, 2026
tkiehn and others added 2 commits July 17, 2026 09:22
…ument remaining backend macros

Replaces Any/bare list/dict/union types with the exact keywords accepted by
dbt-core's validate_macro_args (verified against dbt-core 1.11.7 and 1.12.0
source directly), and adds the missing stage.yml adapter dispatch entries
plus full docs for the previously undocumented staging helper macros, per
tkiehn's review on #489.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 46 out of 46 changed files in this pull request and generated no new comments.

Suppressed comments (3)

macros/staging/staging.yml:25

  • extract_prejoin_column_names documents prejoined_columns as list[dict[string, string]], but process_prejoined_columns produces list items containing lists (e.g. aliases, extract_columns). The type and description should reflect the actual processed shape, and the description has a grammar typo (“process” → “processed”).
      - name: prejoined_columns
        type: list[dict[string, string]]
        description: The prejoined_columns as process by the process_prejoined_columns-macro

macros/staging/staging.yml:8

  • The process_prejoined_columns macro description contains typos/grammar issues (e.g. “dictioniaries”, duplicated “if”) and is hard to parse. Since this is user-facing documentation, it should be corrected for clarity.

This issue also appears on line 23 of the same file.

    description: >
      A macro to process prejoined columns. If a list of dictioniaries(new syntax) is provided it will do nothing and return the list.
      If a dictionary of dictionaries if provided(old syntax) it will be transformed to the new syntax.
      When multiple columns are to be extracted from the same prejoin-target and with the same conditions(columns and operator) they will be combined into one item.

macros/staging/stage.yml:63

  • stage documentation currently describes prejoined_columns as only a dict-of-dicts, but the implementation supports both the new list-of-dicts syntax and the old dict-of-dicts syntax (see process_prejoined_columns). The docs should reflect both supported input shapes to avoid misleading users.
      - name: prejoined_columns
        type: dict[string, dict[string, string]]
        description: >
          Defines information about columns that need to be prejoined. Most commonly used to create links when
          the source data does not hold the Business Key but the technical key of the referred object. For each

stage's and process_prejoined_columns' prejoined_columns accept both the
old dict-of-dicts and new list-of-dicts syntax, so document both and use
type any instead of a single concrete shape. Also fixes typos/grammar in
the process_prejoined_columns description and corrects
extract_prejoin_column_names' item type to dict[string, any], since its
list items mix list- and string-valued keys.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 46 out of 46 changed files in this pull request and generated no new comments.

Suppressed comments (1)

macros/internal/metadata_processing/metadata_processing.yml:47

  • alias_all supports passing either a list or a single string (see macros/internal/metadata_processing/alias_all.sql), and list items can be either plain strings or {source_column, alias} dicts. The argument docs currently restrict this to list[string], which is inaccurate for users relying on generated docs.
      - name: columns
        type: list[string]
        description: List of column definitions, each passed individually to alias().

alias_all accepts either a list of column definitions or a single one,
and each definition is a plain string or a {source_column, alias} dict
(see alias.sql), so type any matches the accepted shapes instead of the
narrower list[string].

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 46 out of 46 changed files in this pull request and generated no new comments.

Suppressed comments (1)

macros/hooks/clean_up_pit.md:26

  • The multiline post_hook example uses a quoted string that spans multiple lines (post_hook="{{ datavault4dbt.clean_up_pit(...), which is not valid Jinja syntax if users copy/paste it into a model (string literals can’t contain raw newlines). Use an unquoted expression for post_hook so the macro call can be formatted across multiple lines.
    post_hook="{{ datavault4dbt.clean_up_pit(
        snapshot_relation='control_snap_v1',
        snapshot_trigger_column='is_active',
        sdts='sdts'
    ) }}"

I verified this against Jinja2 directly unlike Python, Jinja string literals allow raw newlines inside quotes, so post_hook="{{ ... }}" spanning multiple lines parses fine. I also simulated dbt's two-stage hook rendering (outer config() capturing the string, then dbt re-rendering that string before running the hook) and it produced correct output at both stages. Leaving the example as-is. no change needed here!

@tkirschke tkirschke added the testing To trigger the automated test workflow as internal User. label Aug 4, 2026
@remoteworkflow

remoteworkflow Bot commented Aug 4, 2026

Copy link
Copy Markdown

dbt test combined result: ❌


Details

RESULTS for Synapse:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Postgres:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for BigQuery:
❌ dbt-core-tests
❌ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Redshift:
❌ dbt-core-tests
❌ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Snowflake:
❌ dbt-core-tests
❌ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Exasol:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Fabric:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Oracle:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Databricks:
❌ dbt-core-tests
❌ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for SQL Server:
❌ dbt-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Trino:
❌ dbt-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


Link to workflow summary: https://github.com/ScalefreeCOM/datavault4dbt-ci-cd/actions/runs/30897181518

@remoteworkflow remoteworkflow Bot removed the testing To trigger the automated test workflow as internal User. label Aug 4, 2026
{% docs %} blocks render with an empty Jinja context, so the bare
{{ datavault4dbt.hub(...) }}-style usage examples in these .md files were
being executed for real at parse time instead of shown as text, failing
with "'config' is undefined" for every adapter (reproduced locally against
dbt-core 1.12.0, same version the CI/CD pipeline runs). Wrapping each
example in {% raw %}/{% endraw %} keeps them literal.
…eeCOM/datavault4dbt into feat/374-macro-yml-documentation
@tkirschke tkirschke added the testing To trigger the automated test workflow as internal User. label Aug 4, 2026
@remoteworkflow

remoteworkflow Bot commented Aug 4, 2026

Copy link
Copy Markdown

dbt test combined result: ❌


Details

RESULTS for Synapse:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Postgres:
✅ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for BigQuery:
✅ dbt-core-tests
✅ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Redshift:
✅ dbt-core-tests
✅ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Snowflake:
✅ dbt-core-tests
✅ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Exasol:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Fabric:
❌ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Oracle:
✅ dbt-core-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Databricks:
❌ dbt-core-tests
❌ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for SQL Server:
✅ dbt-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


RESULTS for Trino:
❌ dbt-tests
⚠️ dbt-fusion-tests
⚠️ dbt-macro-tests
⚠️ tech-tests


Link to workflow summary: https://github.com/ScalefreeCOM/datavault4dbt-ci-cd/actions/runs/30911769923

@remoteworkflow remoteworkflow Bot removed the testing To trigger the automated test workflow as internal User. label Aug 4, 2026
@tkirschke
tkirschke dismissed tkiehn’s stale review August 5, 2026 07:51

this is solved now from my perspective

@tkirschke
tkirschke merged commit 5fd277b into main Aug 5, 2026
@tkirschke
tkirschke deleted the feat/374-macro-yml-documentation branch August 5, 2026 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-maintainers Waiting for a response from the maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants