-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from fivetran/feature/databricks-compatibility
Feature/databricks compatibility
- Loading branch information
Showing
23 changed files
with
297 additions
and
265 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,130 @@ | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| # Marketo Source ([docs](https://fivetran-dbt-marketo.netlify.app/#!/overview)) | ||
|
|
||
| This package models Marketo data from [Fivetran's connector](https://fivetran.com/docs/applications/marketo). It uses data in the format described by [this ERD](https://fivetran.com/docs/applications/marketo#schema). | ||
|
|
||
| This package enriches your Fivetran data by doing the following: | ||
|
|
||
| * Adds descriptions to tables and columns that are synced using Fivetran | ||
| * 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 [Marketo transformation package](https://github.com/fivetran/dbt_marketo). 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 | ||
| `dbt_marketo_source` currently supports `dbt 0.20.x`. | ||
| <p align="center"> | ||
| <a alt="License" | ||
| href="https://github.com/fivetran/dbt_marketo_source/blob/main/LICENSE"> | ||
| <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a> | ||
| <a alt="dbt-core"> | ||
| <img src="https://img.shields.io/badge/dbt_Core™_version->=1.0.0_,<2.0.0-orange.svg" /></a> | ||
| <a alt="Maintained?"> | ||
| <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a> | ||
| <a alt="PRs"> | ||
| <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a> | ||
| </p> | ||
|
|
||
| # Marketo Source dbt Package ([docs](https://fivetran.github.io/dbt_market_source/)) | ||
| # 📣 What does this dbt package do? | ||
|
|
||
| - Produces staging tables that leverage Marketo data from [Fivetran's connector](https://fivetran.com/docs/applications/marketo) in the format described by [this ERD](https://fivetran.com/docs/applications/marketo#schema). | ||
| - Adds descriptions to tables and columns that are synced using Fivetran | ||
| - Models staging tables, which will be used in our transform package | ||
| - 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 source and modeled Marketo data through the [dbt docs site](https://fivetran.github.io/dbt_marketo_source/). | ||
| - These tables are designed to work simultaneously with our [Marketo transformation package](https://github.com/fivetran/dbt_marketo/). | ||
|
|
||
| # 🎯 How do I use the dbt package? | ||
|
|
||
| ## Step 1: Prerequisites | ||
| To use this dbt package, you must have the following: | ||
|
|
||
| - At least one Fivetran Marketo connector syncing data into your destination. | ||
| - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. | ||
|
|
||
| ### Databricks Dispatch 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 `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'] | ||
| ``` | ||
| 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. | ||
| ## Step 2: Install the package | ||
| Include the following Marketo package version in your `packages.yml` file. | ||
|
|
||
| Include in your `packages.yml` | ||
| > 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 | ||
| ```yml | ||
| packages: | ||
| - package: fivetran/marketo_source | ||
| version: [">=0.7.0", "<0.8.0"] | ||
| version: [">=0.8.0", "<0.9.0"] | ||
| ``` | ||
|
|
||
| ## Configuration | ||
| By default, this package will look for your Marketo data in the `marketo` 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 Marketo data is, add the following configuration to your `dbt_project.yml` file: | ||
| ## Step 3: Define database and schema variables | ||
| By default, this package runs using your destination and the `marketo` 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 Marketo data is (for example, if your Marketo schema is named `marketo_fivetran`), add the following configuration to your root `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
| # dbt_project.yml | ||
| vars: | ||
| marketo_database: your_database_name | ||
| marketo_schema: your_schema_name | ||
| ``` | ||
|
|
||
| ... | ||
| config-version: 2 | ||
| ## Step 4: Enabling/Disabling Models | ||
| This package takes into consideration tables that may not be synced due to slowness caused by the Marketo API. By default the `campaign` and `program` models are disabled. If you sync these tables, enable the modeling done by adding the following to your `dbt_project.yml` file: | ||
| ```yml | ||
| vars: | ||
| marketo__enable_campaigns: true # Enable if Fivetran is syncing the campaign table | ||
| marketo__enable_programs: true # Enable if Fivetran is syncing the program table | ||
| ``` | ||
|
|
||
| Alternatively, you may need to disable certain models. The below models can be disabled by adding them to your `dbt_project.yml` file: | ||
| ```yml | ||
| vars: | ||
| marketo_source: | ||
| marketo_database: your_database_name | ||
| marketo_schema: your_schema_name | ||
| marketo__activity_delete_lead_enabled: false # Disable if you do not have the activity_delete_lead table | ||
| ``` | ||
|
|
||
| ## (Optional) Step 5: Additional configurations | ||
| <details><summary>Expand for details</summary> | ||
| <br> | ||
|
|
||
| ### Changing the Build Schema | ||
| By default this package will build the Marketo staging models within a schema titled (<target_schema> + `_stg_marketo`) in your target database. If this is not where you would like your Marketo data to be written to, add the following configuration to your `dbt_project.yml` file: | ||
| By default this package will build the Marketo staging models within a schema titled (<target_schema> + `_marketo_source`) in your target database. If this is not where you would like your Marketo data to be written to, add the following configuration to your `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
| # dbt_project.yml | ||
| ... | ||
| models: | ||
| marketo_source: | ||
| +schema: my_new_schema_name # leave blank for just the target_schema | ||
| ``` | ||
|
|
||
| ### Enabling Models | ||
| This package takes into consideration tables that may not be synced due to slowness caused by the Marketo API. By default the `campaign` and `program` models are disabled. If you sync these tables, enable the modeling done by adding the following to your `dbt_project.yml` file: | ||
| ### Change the source table references | ||
| If an individual source table has a different name than what 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_marketo_source/blob/main/dbt_project.yml) variable declarations to see the expected names. | ||
|
|
||
| ```yml | ||
| # dbt_project.yml | ||
| ... | ||
| vars: | ||
| marketo__enable_campaigns: True #Enable if Fivetran is syncing the campaign table | ||
| marketo__enable_programs: True #Enable if Fivetran is syncing the program table | ||
| marketo_<default_source_table_name>_identifier: "your_table_name" | ||
| ``` | ||
| </details> | ||
|
|
||
| ## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| <details><summary>Expand for details</summary> | ||
| <br> | ||
|
|
||
| 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). | ||
| </details> | ||
|
|
||
| # 🔍 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.3.0", "<0.4.0"] | ||
| - package: dbt-labs/dbt_utils | ||
| version: [">=0.8.0", "<0.9.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/marketo/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_marketo_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) on the best workflow for contributing to a package! | ||
|
|
||
| Additional contributions to this package are very welcome! Please create issues | ||
| or open PRs against `main`. Check out | ||
| [this post](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) | ||
| on the best workflow for contributing to a package. | ||
|
|
||
| ## Database Support | ||
| This package has been tested on BigQuery, Snowflake and Redshift. | ||
|
|
||
| ## Resources: | ||
| - Provide [feedback](https://www.surveymonkey.com/r/DQ7K7WW) 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 [using Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected] | ||
| - Find all of Fivetran's pre-built dbt packages in our [dbt hub](https://hub.getdbt.com/fivetran/) | ||
| - Learn how to orchestrate your models with [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt) | ||
| - Learn more about Fivetran overall [in our docs](https://fivetran.com/docs) | ||
| - Check out [Fivetran's blog](https://fivetran.com/blog) | ||
| - Learn more about dbt [in the dbt docs](https://docs.getdbt.com/docs/introduction) | ||
| - Check out [Discourse](https://discourse.getdbt.com/) for commonly asked questions and answers | ||
| - Join the [chat](http://slack.getdbt.com/) on Slack for live discussions and support | ||
| - Find [dbt events](https://events.getdbt.com) near you | ||
| - Check out [the dbt blog](https://blog.getdbt.com/) for the latest news on dbt's development and best practices | ||
| # 🏪 Are there any resources available? | ||
| - If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_marketo_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). | ||
| - Have questions or want to just say hi? Book a time during our office hours [on Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.