search

fivetran / dbt_asana_source

Fivetran's Asana source dbt package
https://fivetran.github.io/dbt_asana_source/
Apache License 2.0
4 stars 6 forks source link

readme

Asana Source dbt Package (Docs)

What does this dbt package do?

How do I use the dbt package?

Step 1: Prerequisites

To use this dbt package, you must have the following:

Step 2: Install the package (skip if also using the asana transformation package)

Include the following asana_source package version in your packages.yml file.

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

packages:
- package: fivetran/asana_source
version: [">=0.8.0", "<0.9.0"] # we recommend using ranges to capture non-breaking changes automatically

Step 3: Define database and schema variables

By default, this package runs using your destination and the asana schema. If this is not where your Asana data is (for example, if your Asana schema is named asana_fivetran), add the following configuration to your root dbt_project.yml file:

config-version: 2

vars:
  asana_source:
    asana_database: your_database_name
    asana_schema: your_schema_name

(Optional) Step 4: Additional configurations

Expand for configurations #### Passing Through Additional Columns To add additional columns to tasks use the pass-through column variable. This is useful for adding custom fields not already included in this package. ```yml vars: asana_source: task_pass_through_columns: [custom_status, custom_department] ``` #### Changing the Build Schema By default this package will build the Asana staging models within a schema titled ( + `_stg_asana`) in your destination. If this is not where you would like your Asana staging data to be written to, add the following configuration to your root `dbt_project.yml` file: ```yml models: asana_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_asana_source/blob/main/dbt_project.yml) variable declarations to see the expected names. ```yml vars: asana__identifier: your_table_name ```

(Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™

Expand for more details Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core™ setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).

Does this package have dependencies?

This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the dbt hub 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.


packages:
- package: fivetran/fivetran_utils
version: [">=0.4.0", "<0.5.0"]
- package: dbt-labs/dbt_utils
  version: [">=1.0.0", "<2.0.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 that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/asana_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_asana_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_asana_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).