An 2294/create sf tags (#141)

* snowflake tagging macros * wip * apply tags on run end * wip * add var for controlling when to run tags, remove col lvl support * update db tag values * update model tag values * update readme for how to apply tags * don't log to stdout by default * hardcode schema * bad schema value example * fix db ref
2026-02-06 11:27:00 +00:00 · 2022-10-21 11:00:13 -07:00 · 2022-10-21 11:00:13 -07:00 · f2cda1ccac
commit f2cda1ccac
parent 56d024d155
15 changed files with 265 additions and 12 deletions
--- a/README.md
+++ b/README.md
@ -16,7 +16,7 @@ solana:
      region: <REGION>
      database: SOLANA_DEV
      warehouse: <WAREHOUSE>
-      schema: silver_solana
+      schema: SILVER
      threads: 4
      client_session_keep_alive: False
      query_tag: <TAG>
@ -30,4 +30,46 @@ solana:
 - Check out [Discourse](https://discourse.getdbt.com/) for commonly asked questions and answers
 - Join the [chat](https://community.getdbt.com/) on Slack for live discussions and support
 - Find [dbt events](https://events.getdbt.com) near you
- Check out [the blog](https://blog.getdbt.com/) for the latest news on dbt's development and best practices
+- Check out [the blog](https://blog.getdbt.com/) for the latest news on dbt's development and best practices
+
+## Applying Model Tags
+
+### Database / Schema level tags
+
+Database and schema tags are applied via the `add_database_or_schema_tags` macro.  These tags are inherited by their downstream objects.  To add/modify tags call the appropriate tag set function within the macro.
+
+```
+{{ set_database_tag_value('SOME_DATABASE_TAG_KEY','SOME_DATABASE_TAG_VALUE') }}
+{{ set_schema_tag_value('SOME_SCHEMA_TAG_KEY','SOME_SCHEMA_TAG_VALUE') }}
+```
+
+### Model tags
+
+To add/update a model's snowflake tags, add/modify the `meta` model property under `config`.  Only table level tags are supported at this time via DBT.
+
+```
+{{ config(
+    ...,
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'SOME_PURPOSE'
+            }
+        }
+    },
+    ...
+) }}
+```
+
+By default, model tags are not pushed to snowflake on each load.  You can push a tag update for a model by specifying the `UPDATE_SNOWFLAKE_TAGS` project variable during a run.
+
+```
+dbt run --var '{"UPDATE_SNOWFLAKE_TAGS":True}' -s models/core/core__fact_swaps.sql
+```
+
+### Querying for existing tags on a model in snowflake
+
+```
+select *
+from table(solana.information_schema.tag_references('solana.core.fact_blocks', 'table'));
+```
--- a/dbt_project.yml
+++ b/dbt_project.yml
@ -33,6 +33,9 @@ on-run-start:
  - '{{ sp_create_bulk_get_decoded_instructions_data() }}'
  - '{{ sp_create_bulk_get_validator_metadata() }}'

+on-run-end:
+  - '{{ apply_meta_as_tags(results) }}'
+

 # Configuring models
 # Full documentation: https://docs.getdbt.com/docs/configuring-models
@ -49,3 +52,4 @@ models:

 vars:
  "dbt_date:time_zone": America/Los_Angeles
+  UPDATE_SNOWFLAKE_TAGS: False
--- a/macros/tags/add_database_or_schema_tags.sql
+++ b/macros/tags/add_database_or_schema_tags.sql
@ -0,0 +1,3 @@
+{% macro add_database_or_schema_tags() %}
+    {{ set_database_tag_value('BLOCKCHAIN_NAME','SOLANA') }}
+{% endmacro %}
--- a/macros/tags/snowflake_tagging.sql
+++ b/macros/tags/snowflake_tagging.sql
@ -0,0 +1,127 @@
+{% macro apply_meta_as_tags(results) %}
+    {% if var("UPDATE_SNOWFLAKE_TAGS") %}
+        {{ log('apply_meta_as_tags', info=False) }}
+        {{ log(results, info=False) }}
+        {% if execute %}
+            
+            {%- set tags_by_schema = {} -%}
+            {% for res in results -%}
+                {% if res.node.meta.database_tags %}
+                    
+                    {%- set model_database = res.node.database -%}
+                    {%- set model_schema = res.node.schema -%}
+                    {%- set model_schema_full = model_database+'.'+model_schema -%}
+                    {%- set model_alias = res.node.alias -%}
+
+                    {% if model_schema_full not in tags_by_schema.keys() %}
+                        {{ log('need to fetch tags for schema '+model_schema_full, info=False) }}
+                        {%- call statement('main', fetch_result=True) -%}
+                            show tags in {{model_database}}.{{model_schema}}
+                        {%- endcall -%}
+                        {%- set _ = tags_by_schema.update({model_schema_full: load_result('main')['table'].columns.get('name').values()|list}) -%}
+                        {{ log('Added tags to cache', info=False) }}
+                    {% else %}
+                        {{ log('already have tag info for schema', info=False) }}
+                    {% endif %}
+
+                    {%- set current_tags_in_schema = tags_by_schema[model_schema_full] -%}
+                    {{ log('current_tags_in_schema:', info=False) }}
+                    {{ log(current_tags_in_schema, info=False) }}
+                    {{ log("========== Processing tags for "+model_schema_full+"."+model_alias+" ==========", info=False) }}
+
+                    {% set line -%}
+                        node: {{ res.node.unique_id }}; status: {{ res.status }} (message: {{ res.message }})
+                        node full: {{ res.node}}
+                        meta: {{ res.node.meta}}
+                        materialized: {{ res.node.config.materialized }}
+                    {%- endset %}
+                    {{ log(line, info=False) }}
+
+                    {%- call statement('main', fetch_result=True) -%}
+                        select LEVEL,UPPER(TAG_NAME) as TAG_NAME,TAG_VALUE from table(information_schema.tag_references_all_columns('{{model_schema}}.{{model_alias}}', 'table'))
+                    {%- endcall -%}
+                    {%- set existing_tags_for_table = load_result('main')['data'] -%}
+                    {{ log('Existing tags for table:', info=False) }}
+                    {{ log(existing_tags_for_table, info=False) }}
+
+                    {{ log('--', info=False) }}
+                    {% for table_tag in res.node.meta.database_tags.table %}
+
+                        {{ create_tag_if_missing(current_tags_in_schema,table_tag|upper) }}
+                        {% set desired_tag_value = res.node.meta.database_tags.table[table_tag] %}
+
+                        {{set_table_tag_value_if_different(model_schema,model_alias,table_tag,desired_tag_value,existing_tags_for_table)}}
+                    {% endfor %}
+                    {{ log("========== Finished processing tags for "+model_alias+" ==========", info=False) }}
+                {% endif %}
+            {% endfor %}
+        {% endif %}
+    {% endif %}
+{% endmacro %}
+
+
+{% macro create_tag_if_missing(all_tag_names,table_tag) %}
+	{% if table_tag not in all_tag_names %}
+		{{ log('Creating missing tag '+table_tag, info=False) }}
+        {%- call statement('main', fetch_result=True) -%}
+            create tag if not exists silver.{{table_tag}}
+        {%- endcall -%}
+		{{ log(load_result('main').data, info=False) }}
+	{% else %}
+		{{ log('Tag already exists: '+table_tag, info=False) }}
+	{% endif %}
+{% endmacro %}
+
+{% macro set_table_tag_value_if_different(model_schema,table_name,tag_name,desired_tag_value,existing_tags) %}
+    {{ log('Ensuring tag '+tag_name+' has value '+desired_tag_value+' at table level', info=False) }}
+    {%- set existing_tag_for_table = existing_tags|selectattr('0','equalto','TABLE')|selectattr('1','equalto',tag_name|upper)|list -%}
+    {{ log('Filtered tags for table:', info=False) }}
+    {{ log(existing_tag_for_table[0], info=False) }}
+    {% if existing_tag_for_table|length > 0 and existing_tag_for_table[0][2]==desired_tag_value %}
+        {{ log('Correct tag value already exists', info=False) }}
+    {% else %}
+        {{ log('Setting tag value for '+tag_name+' to value '+desired_tag_value, info=False) }}
+        {%- call statement('main', fetch_result=True) -%}
+            alter table {{model_schema}}.{{table_name}} set tag {{tag_name}} = '{{desired_tag_value}}'
+        {%- endcall -%}
+        {{ log(load_result('main').data, info=False) }}
+    {% endif %}
+{% endmacro %}
+
+{% macro set_column_tag_value_if_different(table_name,column_name,tag_name,desired_tag_value,existing_tags) %}
+    {{ log('Ensuring tag '+tag_name+' has value '+desired_tag_value+' at column level', info=False) }}
+    {%- set existing_tag_for_column = existing_tags|selectattr('0','equalto','COLUMN')|selectattr('1','equalto',tag_name|upper)|list -%}
+    {{ log('Filtered tags for column:', info=False) }}
+    {{ log(existing_tag_for_column[0], info=False) }}
+    {% if existing_tag_for_column|length > 0 and existing_tag_for_column[0][2]==desired_tag_value %}
+        {{ log('Correct tag value already exists', info=False) }}
+    {% else %}
+        {{ log('Setting tag value for '+tag_name+' to value '+desired_tag_value, info=False) }}
+        {%- call statement('main', fetch_result=True) -%}
+            alter table {{table_name}} modify column {{column_name}} set tag {{tag_name}} = '{{desired_tag_value}}'
+        {%- endcall -%}
+        {{ log(load_result('main').data, info=False) }}
+    {% endif %}
+{% endmacro %}
+
+{% macro set_database_tag_value(tag_name,tag_value) %}
+    {% set query %}
+        create tag if not exists silver.{{tag_name}}
+    {% endset %}
+    {% do run_query(query) %}
+    {% set query %}
+        alter database {{target.database}} set tag {{target.database}}.silver.{{tag_name}} = '{{tag_value}}'
+    {% endset %}
+    {% do run_query(query) %}
+{% endmacro %}
+
+{% macro set_schema_tag_value(target_schema,tag_name,tag_value) %}
+    {% set query %}
+        create tag if not exists silver.{{tag_name}}
+    {% endset %}
+    {% do run_query(query) %}
+    {% set query %}
+        alter schema {{target.database}}.{{target_schema}} set tag {{target.database}}.silver.{{tag_name}} = '{{tag_value}}'
+    {% endset %}
+    {% do run_query(query) %}
+{% endmacro %}
--- a/models/core/core__dim_nft_metadata.sql
+++ b/models/core/core__dim_nft_metadata.sql
@ -1,6 +1,13 @@
 {{ 
    config(
-      materialized='view'
+      materialized='view',
+      meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'NFT'
+            }
+        }
+      }
    ) 
 }}

--- a/models/core/core__ez_staking_lp_actions.sql
+++ b/models/core/core__ez_staking_lp_actions.sql
@ -1,5 +1,12 @@
 {{ config(
    materialized = 'table',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'STAKING'
+            }
+        }
+    },
    incremental_strategy = 'delete+insert',
    cluster_by = ['block_timestamp::DATE'],
 ) }}
--- a/models/core/core__fact_gauges_creates.sql
+++ b/models/core/core__fact_gauges_creates.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'GOVERNANCE'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_gauges_votes.sql
+++ b/models/core/core__fact_gauges_votes.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'GOVERNANCE'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_gov_actions.sql
+++ b/models/core/core__fact_gov_actions.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'GOVERNANCE'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_nft_mints.sql
+++ b/models/core/core__fact_nft_mints.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'NFT'
+            }
+        }
+    }
 ) }}

 SELECT
--- a/models/core/core__fact_nft_sales.sql
+++ b/models/core/core__fact_nft_sales.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'NFT'
+            }
+        }
+    }
 ) }}

 SELECT
--- a/models/core/core__fact_proposal_creation.sql
+++ b/models/core/core__fact_proposal_creation.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'GOVERNANCE'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_proposal_votes.sql
+++ b/models/core/core__fact_proposal_votes.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'GOVERNANCE'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_staking_lp_actions.sql
+++ b/models/core/core__fact_staking_lp_actions.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'STAKING'
+            }
+        }
+    }
 ) }}

 SELECT 
--- a/models/core/core__fact_swaps.sql
+++ b/models/core/core__fact_swaps.sql
@ -1,5 +1,12 @@
 {{ config(
-    materialized = 'view'
+    materialized = 'view',
+    meta={
+        'database_tags':{
+            'table': {
+                'PURPOSE': 'SWAPS'
+            }
+        }
+    }
 ) }}

 SELECT