GitHub (Source)

This package models GitHub 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:

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

Models

This package contains staging models, designed to work simultaneously with our GitHub transform package. The staging models:

• 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 user table's ID column is renamed user_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/github_source
    version: [">=0.5.0", "<0.6.0"]

Configuration

By default, this package will run using your target database and the github schema. If this is not where your GitHub data is (perhaps your gitHub schema is Github_fivetran), add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
  github_source:
    github_database: your_database_name
    github_schema: your_schema_name 

Disabling Models

Your Github connector might not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that functionality in Github or have actively excluded some tables from your syncs.

If you do not have the REPO_TEAM table synced, add the following variable to your dbt_project.yml file:

# dbt_project.yml
config-version: 2

vars:
    github__using_repo_team: false # by default this is assumed to be true

Note: This package only integrates the above variable. If you'd like to disable other models, please create an issue specifying which ones.

Database support

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

Contributions

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

Resources:

• Provide feedback on our existing dbt packages or what you'd like to see next
• Have questions, feedback, or need help? Book a time during our office hours here or email us at [email protected]
• Find all of Fivetran's pre-built dbt packages in our dbt hub
• Learn how to orchestrate your models with Fivetran Transformations for dbt Core™
• Learn more about Fivetran in the Fivetran docs
• Check out Fivetran's blog
• Learn more about dbt in the dbt docs
• Check out Discourse for commonly asked questions and answers
• Join the chat on Slack for live discussions and support
• Find dbt events near you
• Check out the dbt blog for the latest news on dbt's development and best practices