Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fivetran/dbt_instagram_business_source
Fivetran's Instagram Business source dbt package
https://github.com/fivetran/dbt_instagram_business_source
dbt dbt-packages fivetran instagram social-media-analysis
Last synced: 23 days ago
JSON representation
Fivetran's Instagram Business source dbt package
- Host: GitHub
- URL: https://github.com/fivetran/dbt_instagram_business_source
- Owner: fivetran
- License: apache-2.0
- Created: 2021-10-07T14:04:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T20:41:05.000Z (4 months ago)
- Last Synced: 2024-09-07T20:37:18.003Z (4 months ago)
- Topics: dbt, dbt-packages, fivetran, instagram, social-media-analysis
- Language: Shell
- Homepage: https://fivetran.github.io/dbt_instagram_business_source/
- Size: 1.21 MB
- Stars: 2
- Watchers: 40
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Instagram Business Source dbt Package ([Docs](https://fivetran.github.io/dbt_instagram_business_source/))
# 📣 What does this dbt package do?
- Materializes [Instagram Business staging tables](https://fivetran.github.io/dbt_instagram_business_source/#!/overview/instagram_business_source/models/?g_v=1) which leverage data in the format described by [this ERD](https://fivetran.com/docs/applications/instagram-business#schemainformation). These staging tables clean, test, and prepare your Instagram Business data from [Fivetran's connector](https://fivetran.com/docs/applications/instagram-business) for analysis by doing the following:
- Name columns for consistency across all packages and for easier analysis
- 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.
- Generates a comprehensive data dictionary of your Instagram Business data through the [dbt docs site](https://fivetran.github.io/dbt_instagram_business_source/).
- This package contains staging models, designed to work simultaneously with our [Instagram Business transform package](https://github.com/fivetran/dbt_instagram_business) and our [Social Media Reporting package](https://github.com/fivetran/dbt_social_media_reporting).
# 🎯 How do I use the dbt package?
## Step 1: Prerequisites
To use this dbt package, you must have the following:
- A Fivetran Instagram Business connector syncing data into your destination.
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.
### Databricks Additional Configuration
If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your root `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively.
```yml
dispatch:
- macro_namespace: dbt_utils
search_order: ['spark_utils', 'dbt_utils']
```
## Step 2: Install the package
Include the following instagram_business_source package version in your `packages.yml` file **only if you are NOT also installing the [Instagram Business transformation package](https://github.com/fivetran/dbt_instagram_business_source)**. The transform package has a dependency on this source package.
> TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
```yaml
packages:
- package: fivetran/instagram_business_source
version: [">=0.2.0", "<0.3.0"]
```
## Step 3: Define database and schema variables
By default, this package will look for your Instagram Business data in the `instagram_business` schema of your [target database](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile). If this is not where your Instagram Business data is, please add the following configuration to your `dbt_project.yml` file:
```yml
vars:
instagram_business_schema: your_schema_name
instagram_business_database: your_database_name
```
## (Optional) Step 4: Additional Configurations
Expand for configurations
### Changing the Build Schema
By default, this package will build the Instagram Business staging models within a schema titled (`` + `_stg_instagram_business`) in your target database. If this is not where you would like your Instagram Business staging data to be written to, add the following configuration to your `dbt_project.yml` file:
```yml
models:
instagram_business_source:
+schema: my_new_schema_name # leave blank for just the target_schema
```
### Change the source table references
If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_instagram_business_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
```yml
vars:
instagram_business__identifier: your_table_name
```
### Unioning Multiple Instagram Business Connectors
If you have multiple Instagram Business connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table(s) into the final models. You will be able to see which source it came from in the `source_relation` column(s) of each model. To use this functionality, you will need to set either (**note that you cannot use both**) the `union_schemas` or `union_databases` variables:
```yml
# dbt_project.yml
...
config-version: 2
vars:
##You may set EITHER the schemas variables below
instagram_business_union_schemas: ['instagram_business_one','instagram_business_two']
##Or may set EITHER the databases variables below
instagram_business_union_databases: ['instagram_business_one','instagram_business_two']
```
# (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™
Expand for configurations
Fivetran offers the ability for you to orchestrate your dbt project through the [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt) product. Refer to the linked docs for more information on how to setup your project for orchestration through Fivetran.
# 🔍 Does this package have dependencies?
This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.
> IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.
```yml
packages:
- package: fivetran/fivetran_utils
version: [">=0.4.0", "<0.5.0"]
- package: dbt-labs/dbt_utils
version: [">=1.0.0", "<2.0.0"]
- package: dbt-labs/spark_utils
version: [">=0.3.0", "<0.4.0"]
```
# 🙌 How is this package maintained and can I contribute?
## Package Maintenance
The Fivetran team maintaining this package **only** maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/instagram_business_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_instagram_business_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.
### Contributions
A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions.
We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) to learn how to contribute to a dbt package.
## Are there any resources available?
- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_amazon_ads_source/issues/new/choose) section to find the right avenue of support for you.
- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).