From the SELECT team, a dbt package to automatically tag dbt-issued queries with informative metadata. This package uses both query comments and query tagging.
An example query comment contains:
{
"dbt_snowflake_query_tags_version": "2.0.2",
"app": "dbt",
"dbt_version": "1.4.0",
"project_name": "my_project",
"target_name": "dev",
"target_database": "dev",
"target_schema": "dev",
"invocation_id": "4ffa20a1-5d90-4a27-a58a-553bb6890f25",
"node_refs": [
"model_b",
"model_c"
],
"node_name": "model_a",
"node_alias": "model_a",
"node_package_name": "my_project",
"node_original_file_path": "models/model_a.sql",
"node_database": "dev",
"node_schema": "dev",
"node_id": "model.my_project.model_a",
"node_resource_type": "model",
"node_tags": ["tag_1", "tag_2"],
"materialized": "incremental",
-- dbt Cloud only
"dbt_cloud_project_id": "146126",
"dbt_cloud_job_id": "184124",
"dbt_cloud_run_id": "107122910",
"dbt_cloud_run_reason_category": "other",
"dbt_cloud_run_reason": "Kicked off from UI by niall@select.dev",
}
Query tags are used solely for attaching the is_incremental
flag, as this isn't available to the query comment:
{
"dbt_snowflake_query_tags_version": "2.0.1",
"app": "dbt",
"is_incremental": true
}
- Add this package to your
packages.yml
file, then install it withdbt deps
.
packages:
- package: get-select/dbt_snowflake_query_tags
version: 2.0.0
- Adding the query tags
Option 1: If running dbt < 1.2, create a folder named macros
in your dbt project's top level directory (if it doesn't exist). Inside, make a new file called query_tags.sql
with the following content:
{% macro set_query_tag() -%}
{% do return(dbt_snowflake_query_tags.set_query_tag()) %}
{% endmacro %}
{% macro unset_query_tag(original_query_tag) -%}
{% do return(dbt_snowflake_query_tags.unset_query_tag(original_query_tag)) %}
{% endmacro %}
Option 2: If running dbt >= 1.2, simply configure the dispatch search order in dbt_project.yml
.
dispatch:
- macro_namespace: dbt
search_order:
- <YOUR_PROJECT_NAME>
- dbt_snowflake_query_tags
- dbt
- To configure the query comments, add the following config to
dbt_project.yml
.
query-comment:
comment: '{{ dbt_snowflake_query_tags.get_query_comment(node) }}'
append: true # Snowflake removes prefixed comments.
That's it! All dbt-issued queries will now be tagged.
We use changie to generate CHANGELOG entries. Note: Do not edit the CHANGELOG.md directly. Your modifications will be lost.
Follow the steps to install changie for your system.
Once changie is installed and your PR is created, simply run changie new
and changie will walk you through the process of creating a changelog entry. Commit the file that's created and your changelog entry is complete!