Macros for reusable SQL logic in dbt

Introduction

Macros help you write SQL code once and use it many times. This saves time and keeps your work neat.

When you need to repeat the same SQL calculation in many places.

When you want to keep your SQL code clean and easy to read.

When you want to change a logic in one place and update it everywhere.

When you want to avoid mistakes by reusing tested SQL snippets.

When you want to make your SQL code easier to maintain.

Syntax

dbt

{% macro macro_name(arg1, arg2) %}
  -- SQL code using {{ arg1 }} and {{ arg2 }}
{% endmacro %}

-- Use macro in SQL:
{{ macro_name(value1, value2) }}

Macros are written inside {% %} tags.

You call macros using double curly braces {{ }}.

Examples

This macro adds two numbers and returns the sum.

dbt

{% macro add_numbers(a, b) %}
  {{ a }} + {{ b }}
{% endmacro %}

SELECT {{ add_numbers(5, 3) }} AS sum;

This macro selects only active rows from a given table.

dbt

{% macro filter_active(table) %}
  SELECT * FROM {{ table }} WHERE status = 'active'
{% endmacro %}

{{ filter_active('users') }}

Sample Program

This example defines a macro to calculate discounted prices. It then uses this macro in a query to get discounted prices for sales data.

dbt

{% macro calculate_discount(price, discount_rate) %}
  ROUND({{ price }} * (1 - {{ discount_rate }}), 2)
{% endmacro %}

WITH sales AS (
  SELECT 100 AS price, 0.1 AS discount_rate
  UNION ALL
  SELECT 200, 0.15
)

SELECT
  price,
  discount_rate,
  {{ calculate_discount(price, discount_rate) }} AS discounted_price
FROM sales;

Important Notes

Macros can take multiple arguments to make them flexible.

Use macros to avoid repeating complex SQL code.

Macros help keep your project DRY (Don't Repeat Yourself).

Summary

Macros let you reuse SQL code easily.

They make your SQL cleaner and easier to maintain.

Use macros to save time and reduce errors.

Practice

1. What is the main purpose of using macros in dbt?

easy

A. To create visualizations from data

B. To store data permanently in the database

C. To reuse SQL code and make it easier to maintain

D. To write Python scripts inside dbt

Solution

1. Step 1: Understand what macros do

   Macros are reusable pieces of SQL code that help avoid repetition.

2. Step 2: Identify the main benefit

   Using macros makes SQL cleaner and easier to maintain by reusing code.

3. Final Answer:

   To reuse SQL code and make it easier to maintain -> Option C

4. Quick Check:

   Macros = reusable SQL code [OK]

Hint: Macros = reusable SQL snippets for cleaner code [OK]

Common Mistakes:

• Thinking macros store data
• Confusing macros with visualization tools
• Assuming macros run Python code

2. Which of the following is the correct way to define a macro in dbt?

easy

A. {% macro my_macro() %} SELECT * FROM table {% endmacro %}

B. CREATE MACRO my_macro AS SELECT * FROM table;

C. def my_macro(): SELECT * FROM table

D. macro my_macro() { SELECT * FROM table }

Solution

1. Step 1: Recall dbt macro syntax

   dbt macros use Jinja templating with {% macro %} and {% endmacro %} tags.

2. Step 2: Match syntax to options

   {% macro my_macro() %} SELECT * FROM table {% endmacro %} correctly uses Jinja syntax for defining a macro.

3. Final Answer:

   {% macro my_macro() %} SELECT * FROM table {% endmacro %} -> Option A

4. Quick Check:

   dbt macros use {% macro %} ... {% endmacro %} [OK]

Hint: Look for {% macro %} and {% endmacro %} tags [OK]

Common Mistakes:

• Using SQL CREATE MACRO syntax (not dbt)
• Writing Python function syntax
• Using curly braces without Jinja tags

3. Given this macro definition:

{% macro select_active_users() %}
SELECT * FROM users WHERE active = true
{% endmacro %}

What will be the output SQL of this dbt model?

SELECT id, name FROM ({{ select_active_users() }})

medium

A. SELECT id, name FROM {{ select_active_users() }}

B. SELECT id, name FROM users WHERE active = true

C. Error: Macro call syntax incorrect

D. SELECT id, name FROM (SELECT * FROM users WHERE active = true)

Solution

1. Step 1: Understand macro expansion

   The macro returns the SQL: SELECT * FROM users WHERE active = true.

2. Step 2: Substitute macro call in model SQL

   The model SQL becomes: SELECT id, name FROM (SELECT * FROM users WHERE active = true)

3. Final Answer:

   SELECT id, name FROM (SELECT * FROM users WHERE active = true) -> Option D

4. Quick Check:

   Macro expands SQL inside parentheses [OK]

Hint: Macros insert SQL code where called [OK]

Common Mistakes:

• Forgetting parentheses around macro SQL
• Thinking macro returns table name only
• Using macro call without {{ }}

4. Identify the error in this macro definition:

{% macro get_orders() %}
SELECT * FROM orders

medium

A. Macro name cannot have underscores

B. Missing {% endmacro %} tag to close the macro

C. SELECT statement must be inside double quotes

D. Macro cannot return SELECT statements

Solution

1. Step 1: Check macro syntax

   Macros must start with {% macro %} and end with {% endmacro %} tags.

2. Step 2: Identify incorrect closing tag

   The macro incorrectly uses instead of {% endmacro %}.

3. Final Answer:

   Missing {% endmacro %} tag to close the macro -> Option B

4. Quick Check:

   Macro must end with {% endmacro %} [OK]

Hint: Always close macros with {% endmacro %} [OK]

Common Mistakes:

• Using HTML-like closing tags
• Thinking underscores are invalid
• Believing SELECT needs quotes in macros

5. You want to create a macro that accepts a table name and a column name, then returns SQL to count distinct values in that column. Which macro definition correctly achieves this?

hard

A. {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT {{ column }}) FROM {{ table }} {% endmacro %}

B. {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT column) FROM table {% endmacro %}

C. {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT '{{ column }}') FROM '{{ table }}' {% endmacro %}

D. {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT $column) FROM $table {% endmacro %}

Solution

1. Step 1: Understand macro parameters usage

   Parameters must be inserted with {{ }} to inject SQL identifiers.

2. Step 2: Check each option for correct syntax

   {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT {{ column }}) FROM {{ table }} {% endmacro %} correctly uses {{ column }} and {{ table }} without quotes, so SQL identifiers are injected properly.

3. Final Answer:

   {% macro count_distinct(table, column) %} SELECT COUNT(DISTINCT {{ column }}) FROM {{ table }} {% endmacro %} -> Option A

4. Quick Check:

   Use {{ }} to insert parameters as SQL code [OK]

Hint: Use {{ }} to insert macro parameters in SQL [OK]

Common Mistakes:

• Putting parameters inside quotes (makes them strings)
• Using $variable syntax (not Jinja)
• Not wrapping parameters with {{ }}