Skip to content
dbtvault

Extending

Extending dbtvault

This page describes how write your own macros to replace existing macros provided in dbtvault.

adapter.dispatch

Every macro in dbtvault first calls adapter.dispatch to find platform specific implementations of the macro to execute.

Here is an example:

1
2
3
4
5
6
7
{%- macro hub(src_pk, src_nk, src_ldts, src_source, source_model) -%}

{{- adapter.dispatch('hub', 'dbtvault')(src_pk=src_pk, src_nk=src_nk,
                                        src_ldts=src_ldts, src_source=src_source,
                                        source_model=source_model) -}}

{%- endmacro -%}

This snippet defines the macro namespace as 'dbtvault', ensuring that this macro gets found in the list of macros implemented in the dbtvault package namespace.

To override the hub macro and ensure dbt uses your own implementation of it, you simply need to provide a configuration in your dbt_project.yml as follows:

1
2
3
4
5
6
7
8
name: my_dbt_project
version: 1.0.0

config-version: 2

dispatch:
  - macro_namespace: dbtvault
    search_order: ['my_project', 'dbtvault']  # enable override

With this configuration change, an implementation of the hub macro could be defined in your own project as follows:

1
2
3
4
5
{%- macro default__hub(src_pk, src_nk, src_ldts, src_source, source_model) -%}

    {%- do log("My super amazing implementation of a hub macro will be coming soon!", true) -%}

{%- endmacro -%}

Here are some further examples, showing how to override a platform-specific implementation:

1
2
3
4
5
{%- macro default__hub(src_pk, src_nk, src_ldts, src_source, source_model) -%}

    {%- do log("My super amazing implementation of a hub macro for Snowflake will be coming soon!", true) -%}

{%- endmacro -%}

1
2
3
4
5
{%- macro bigquery__hub(src_pk, src_nk, src_ldts, src_source, source_model) -%}

    {%- do log("My super amazing implementation of a hub macro for BigQuery will be coming soon!", true) -%}

{%- endmacro -%}

1
2
3
4
5
{%- macro sqlserver__hub(src_pk, src_nk, src_ldts, src_source, source_model) -%}

    {%- do log("My super amazing implementation of a hub macro for MS SQL Server will be coming soon!", true) -%}

{%- endmacro -%}

...and that's it! Yay!

Further reading

Please ensure you read the dbt adapter.dispatch and dispatch config docs for more details.

Last update: 2022-02-18
Back to top