■ はじめに

https://dk521123.hatenablog.com/entry/2023/11/29/003751

の続き。

DBT の Macro 作ったので、実用的な例をメモしておく

【１】macro の引数
　１）デフォルト引数
【２】例外
　１）例外をスローする
【３】コメント文
【４】デバッグログ機能
　１）print()文
　２）log()関数
【５】サンプル
　例１：PostgreSQL/Snowflake での UTC時間取得
　例２：クリーン処理

【１】macro の引数

* 以下が参考になる

https://zenn.dev/mashiike/articles/79fd09a3a1a7cc
https://zenn.dev/mashiike/books/f51a51997c2f0e/viewer/816fa9

１）デフォルト引数

{%- macro demo_func(msg1='hello', msg2='world') %}
-- {{ msg1 }} {{ msg2 }}
{%- endmacro %}

【２】例外

１）例外をスローする

* exceptions.raise_compiler_error() でスローできる

https://docs.getdbt.com/reference/dbt-jinja-functions/exceptions

{% if number < 0 or number > 100 %}
  {{ exceptions.raise_compiler_error("Invalid `number`. Got: " ~ number) }}
{% endif %}

【３】コメント文

* dbt というよりJinja2

Jinja2 ～基本編～
https://dk521123.hatenablog.com/entry/2024/10/18/001757

{# コメント文 #}

{#
コメント文１
コメント文２
#}

https://tekunabe.hatenablog.jp/entry/2021/12/03/jinja2_comment

【４】デバッグログ機能

１）print()文

* ログとして、print()文が用意されている

macros/demo_macro.sql

{% macro demo_macro(user_id) -%}
  {{ print(user_id) }}
{%- endmacro %}

コマンド例

# Suppress all non-error logging to stdout.
# Does not affect {{ print() }} macro calls.
$ dbt run-operation demo_macro --args '{user_id: X001}' --quiet
X001

２）log()関数

* ログ

https://docs.getdbt.com/reference/dbt-jinja-functions/log
構文

-- msg：メッセージ
-- info：False：ログファイルだけ。
-- True：ログファイルと標準出力 (default=False)
def log(msg: str, info: bool = False) -> str:

サンプル

{% macro some_macro(arg1, arg2) %}
  {{ log("Running some_macro: " ~ arg1 ~ ", " ~ arg2) }}
  -- ~(チルダ)：文字列連結（Pythonの「＋」）

  {{ log("Hello"), True) }}
  {{ log("World", info=True) }}
{% endmacro %}

【５】サンプル

例１：PostgreSQL/Snowflake での UTC時間取得

-- 呼び出し側
SELECT
 {{ utc_current_timestamp('YYYY-MM-DD') }} AS current_date
FROM
 demo_table;

macros/utc_current_timestamp.sql

{% macro utc_current_timestamp(datetime_format) -%}
    {{ return(adapter.dispatch('utc_current_timestamp')(datetime_format)) }}
{%- endmacro %}

-- For PostgreSQL
{% macro postgres__utc_current_timestamp(datetime_format) %}
    to_char(current_timestamp at time zone 'UTC', datetime_format)
{% endmacro %}

-- For Snowflake
{% macro snowflake__utc_current_timestamp(datetime_format) %}
    TO_VARCHAR(sysdate(), datetime_format)
{% endmacro %}

例２：クリーン処理

-- 呼び出し側
SELECT
 {{ clean('id') }} AS id,
 {{ clean('name') }} AS name,
 {{ clean('age') }} AS age
FROM
 demo_table;

macros/clean.sql

{% macro clean(target_item) -%}
  CASE WHEN UPPER(TRIM({{ target_item }})) IN ('','\"\"','N/A','NULL') THEN NULL ELSE TRIM({{ target_item }}) END
{%- endmacro %}