/dbt_stripe_source

Fivetran's Stripe source dbt package

Apache License 2.0Apache-2.0

Apache License dbt logo and version

Stripe

This package models Stripe data from Fivetran's connector. It uses data in the format described by this ERD.

This package enriches your Fivetran data by doing the following:

  • Add descriptions to tables and columns that are synced using Fivetran
  • Add freshness tests to source data
  • Add column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
  • Model staging tables, which will be used in our transform package

Models

This package contains staging models, designed to work simultaneously with our Stripe modeling package. The staging models are designed to:

  • Remove any rows that are soft-deleted
  • Name columns consistently across all packages:
    • Boolean fields are prefixed with is_ or has_
    • Timestamps are appended with _at
    • ID primary keys are prefixed with the name of the table. For example, the card table's ID column is renamed card_id.

Installation Instructions

Check dbt Hub for the latest installation instructions, or read the dbt docs for more information on installing packages.

Include in your packages.yml

packages:
  - package: fivetran/stripe_source
    version: [">=0.4.0", "<0.5.0"]

Configuration

By default, this package will look for your Stripe data in the stripe schema of your target database. If this is not where your Stripe data is, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
    stripe_schema: your_schema_name
    stripe_database: your_database_name

Disabling Models

This package takes into consideration that not every Stripe account utilizes the invoice, invoice_line_item, payment_method, payment_method_card, plan, or subscription features, and allows you to disable the corresponding functionality. By default, all variables' values are assumed to be true. Add variables for only the tables you want to disable:

# dbt_project.yml

...
vars:
    using_invoices:        False  #Disable if you are not using the invoice and invoice_line_item tables
    using_payment_method:  False  #Disable if you are not using the payment_method and payment_method_card tables
    using_subscriptions:   False  #Disable if you are not using the subscription and plan tables.

Changing the Build Schema

By default this package will build the Stripe staging models within a schema titled (<target_schema> + _stg_stripe). If this is not where you would like your Stripe staging models to be written to, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
models:
  stripe_source:
    +schema: my_new_staging_models_schema # leave blank for just the target_schema

Read more about using custom schemas in dbt here.

Contributions

Additional contributions to this package are very welcome! Please create issues or open PRs against master. Check out this post on the best workflow for contributing to a package.

Database support

This package has been tested on BigQuery, Snowflake, and Redshift.

Resources: