snowflake-helper-dbt

A re-usable Snowflake helper package for dbt.

Macros

General

General macros to help working with Snowflake

sfc_source(schema_name, table_name) (source)

This macro is a wrapper around the builtin source() function which allows for dynamicly changing which source table is referenced by the current model.

Usage:

FROM {{ sfc_helper.sfc_source('CITIBIKE', 'PROGRAMS') }}

Parameters:

schema_name: the name of the schema where the source table resides
table_name: the name of the source table

sfc_ref(model_name) (source)

This macro is a wrapper around the builtin ref() function which allows for dynamicly changing which model is referenced by the current model.

Materializations

Custom materializations which leverage native Snowflake capabilities

sfc_incremental (source)

An incremental materialization pattern which leverages Snowflake streams for CDC.

This materialization is appropriate for cases when the source table does not have an update timestamp column or when performance is poor. If the stream does not exist on the table then the materialization will create it.

Check out the Snowflake table stream documentation for more details.

Usage:

{{
    config(
        materialized='sfc_incremental',
        transient=false,
        unique_key='PROGRAM_ID' 
    )
}}

SELECT
     PROGRAM_ID
    ,PROGRAM_NAME
    ,RANGE_START
    ,RANGE_END
    {{ sfc_helper.sfc_get_stream_metadata_columns() }}
FROM {{ sfc_helper.sfc_source('CITIBIKE', 'PROGRAMS') }}
WHERE 1 = 1
    {{ sfc_helper.sfc_get_stream_metadata_filters() }}

Configuration values:

unique_key: the column used to uniquely identify a record and which is used to determine if a record has changed

sfc_task (source)

An experimental materialization to manage Snowflake tasks. Not sure if this fits the dbt paradigm correctly.

Legal

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this connector except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

jeremiahhansen/snowflake-helper-dbt