Skip to content

FlipsideCrypto/mantle-models

Repository files navigation

Repo Set Up

  1. Create a new repository from the evm-models-template
  2. Update all references to <evm_chain> to the new chain name, in lowercase by using find and replace
  3. Update the fsc-evm package version in packages.yml to the latest version
  4. Set up the rest of the dbt project, where applicable, including but not limited to:
    • dbt_project.yml (enable/disable packages, vars, etc.)
    • .github/workflows (update tags, etc.)
    • github_actions__workflows.csv (update schedule, workflows, etc.)
    • overview.md (update <evm_chain>, table references, docs etc.)
    • sources.yml (update schemas, tables etc.)
    • requirements.txt (update dependencies)
    • other files where applicable

Profile Set Up

Use the following within profiles.yml


<chain>: -- replace <chain>/<CHAIN> with the profile or name from, remove this comment in your yml
  target: dev
  outputs:
    dev:
      type: snowflake
      account: <ACCOUNT>
      role: INTERNAL_DEV
      user: <USERNAME>
      authenticator: externalbrowser
      region: us-east-1
      database: <CHAIN>_DEV
      warehouse: DBT
      schema: silver
      threads: 4
      client_session_keep_alive: False
      query_tag: dbt_<USERNAME>_dev

    prod:
      type: snowflake
      account: <ACCOUNT>
      role: DBT_CLOUD_<CHAIN>
      user: <USERNAME>
      authenticator: externalbrowser
      region: us-east-1
      database: <CHAIN>
      warehouse: DBT_CLOUD_<CHAIN>
      schema: silver
      threads: 4
      client_session_keep_alive: False
      query_tag: dbt_<USERNAME>_dev

Common DBT Run Variables

The following variables can be used to control various aspects of the dbt run. Use them with the --vars flag when running dbt commands.

Variable Description Example Usage
UPDATE_UDFS_AND_SPS Update User Defined Functions and Stored Procedures. By default, this is set to False --vars '{"UPDATE_UDFS_AND_SPS":true}'
STREAMLINE_INVOKE_STREAMS Invoke Streamline processes. By default, this is set to False --vars '{"STREAMLINE_INVOKE_STREAMS":true}'
STREAMLINE_USE_DEV_FOR_EXTERNAL_TABLES Use development environment for external tables. By default, this is set to False --vars '{"STREAMLINE_USE_DEV_FOR_EXTERNAL_TABLES":true}'
HEAL_CURATED_MODEL Heal specific curated models. By default, this is set to an empty array []. See more below. --vars '{"HEAL_CURATED_MODEL":["axelar","across","celer_cbridge"]}'
UPDATE_SNOWFLAKE_TAGS Control updating of Snowflake tags. By default, this is set to False --vars '{"UPDATE_SNOWFLAKE_TAGS":false}'
START_GHA_TASKS Start GitHub Actions tasks. By default, this is set to False --vars '{"START_GHA_TASKS":true}'

Example Commands

  1. Update UDFs and SPs:

    dbt run --vars '{"UPDATE_UDFS_AND_SPS":true}' -m ...
    
  2. Invoke Streamline and use dev for external tables:

    dbt run --vars '{"STREAMLINE_INVOKE_STREAMS":true,"STREAMLINE_USE_DEV_FOR_EXTERNAL_TABLES":true}' -m ...
    
  3. Heal specific curated models:

    dbt run --vars '{"HEAL_CURATED_MODEL":["axelar","across","celer_cbridge"]}' -m ...
    
  4. Update Snowflake tags for a specific model:

    dbt run --vars '{"UPDATE_SNOWFLAKE_TAGS":true}' -s models/silver/utilities/silver__number_sequence.sql
    
  5. Start GHA tasks:

    dbt seed -s github_actions__workflows && dbt run -m models/github_actions --full-refresh && dbt run-operation fsc_utils.create_gha_tasks --vars '{"START_GHA_TASKS":True}'
    
  6. Using two or more variables:

    dbt run --vars '{"UPDATE_UDFS_AND_SPS":true,"STREAMLINE_INVOKE_STREAMS":true,"STREAMLINE_USE_DEV_FOR_EXTERNAL_TABLES":true}' -m ...
    

Note: Replace -m ... with appropriate model selections or tags as needed for your project structure.

FSC_EVM

fsc_evm is a collection of macros, models, and other resources that are used to build the Flipside Crypto EVM models.

For more information on the fsc_evm package, see the FSC_EVMWiki.

Applying Model Tags

Database / Schema level tags

Database and schema tags are applied via the fsc_evm.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.

{{ fsc_evm.set_database_tag_value('SOME_DATABASE_TAG_KEY','SOME_DATABASE_TAG_VALUE') }}
{{ fsc_evm.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.

{% raw %} {{ config( ..., meta={ 'database_tags':{ 'table': { 'PURPOSE': 'SOME_PURPOSE' } } }, ... ) }} {% endraw %}

By default, model tags are pushed to Snowflake on each load. You can disable this by setting the UPDATE_SNOWFLAKE_TAGS project variable to False during a run.

dbt run --vars '{"UPDATE_SNOWFLAKE_TAGS":False}' -s models/silver/utilities/silver__number_sequence.sql

Querying for existing tags on a model in snowflake

select *
from table(<chain>.information_schema.tag_references('<chain>.core.fact_blocks', 'table'));

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •