![[DBT] Add Query comments for better debugging [Tip-3]](https://miro.medium.com/v2/resize:fit:875/1*Hx2Q3-40j9PbdQBFnmibcg.png "[DBT] Add Query comments for better debugging [Tip-3]")
[DBT] Add Query comments for better debugging [Tip-3]
Last Updated on July 20, 2023 by Editorial Team
Author(s): Karthikeyan Siva Baskaran
Originally published on Towards AI.
Software Engineering
Customize the query comment in each query that triggered from dbt
Using query_comment in dbt, we can customize the comments to inject into each query that gets triggered from dbt. For example, the query run by which user/role, on which warehouse and what profile, etc.
Default comment by dbt
By default, the comment will be prepended for the query, in case if you want to have the comment at the end of the query. Set append mode in dbt_project.yml
Customize the comment using macro
Add below macro in query_comment.sql under macro section in dbt project
And, add the macro to dbt_project.yml
The below comment will be appended to all the queries that get triggered from dbt. You can see this under query history in the Snowflake history tab.
/* {"app": "dbt", "dbt_version": "0.21.0", "profile_name": "transformer_profile", "target_name": "dev", "target_database": "silver", "target_warehouse": "transform_wh", "target_user": "transform_user", "target_role": "transformer", "target_account": "dev-account", "file": "models/silver/fin/silver__fin__invest.sql", "node_id": "model.transformer.silver__fin__invest", "node_name": "silver__fin__invest", "resource_type": "model", "package_name": "transformer", "relation": {"database": "silver", "schema": "fin", "identifier": "invest"}} */
The above same code is also maintained under this ever-growing git repository.
GitHub – karthikeyan-sivabaskaran/dbt-tips-and-tricks-series: This repo will keep growing to demo…
You can't perform that action at this time. You signed in with another tab or window. You signed out in another tab or…
github.com
I hope this article helped you to customise the query comments. If you like this blog, please share it with your teammates, friends, and clap U+1F44F in the range of 1 to 50 in Medium. You can clap up to 50 times per post.
Happy Commenting!
This article is part of DBT Tips and Tricks Series. Previous articles like below:
[DBT] Override Default Schema with Custom Schema name [Tip-1]
Problem
medium.com
[DBT] Set Snowflake Query Tag for each DBT model [Tip-2]
Query Tag feature in DBT is a database-specific configuration. In this article, let see how to customize it for…
medium.com
Join thousands of data leaders on the AI newsletter. Join over 80,000 subscribers and keep up to date with the latest developments in AI. From research to projects and ideas. If you are building an AI startup, an AI-related product, or a service, we invite you to consider becoming a sponsor.
Published via Towards AI
Towards AI Academy
We Build Enterprise-Grade AI. We'll Teach You to Master It Too.
15 engineers. 100,000+ students. Towards AI Academy teaches what actually survives production.
Start free — no commitment:
→ 6-Day Agentic AI Engineering Email Guide — one practical lesson per day
→ Agents Architecture Cheatsheet — 3 years of architecture decisions in 6 pages
Our courses:
→ AI Engineering Certification — 90+ lessons from project selection to deployed product. The most comprehensive practical LLM course out there.
→ Agent Engineering Course — Hands on with production agent architectures, memory, routing, and eval frameworks — built from real enterprise engagements.
→ AI for Work — Understand, evaluate, and apply AI for complex work tasks.
Note: Article content contains the views of the contributing authors and not Towards AI.
Related posts
Recent Posts
