From 8ffc9057a699d0ff2754f23f67f2e0fec5765eee Mon Sep 17 00:00:00 2001 From: fivetran-catfritz <111930712+fivetran-catfritz@users.noreply.github.com> Date: Tue, 21 Jan 2025 19:28:26 -0600 Subject: [PATCH] Feature: Add Quickstart Model Counts to README (#39) * MagicBot/add-model-counts updates * Update README.md --- CHANGELOG.md | 6 ++++++ README.md | 17 ++++++++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4cac5a9..15934d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# dbt_microsoft_ads version.version + +## Documentation +- Added Quickstart model counts to README. ([#39](https://github.com/fivetran/dbt_microsoft_ads/pull/39)) +- Corrected references to connectors and connections in the README. ([#39](https://github.com/fivetran/dbt_microsoft_ads/pull/39)) + # dbt_microsoft_ads v0.9.0 [PR #34](https://github.com/fivetran/dbt_microsoft_ads/pull/34) includes the following updates: diff --git a/README.md b/README.md index 6d44670..c1bc942 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -

+# Microsoft Ads Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_microsoft_ads/)) + +

@@ -13,7 +15,6 @@

-# Microsoft Ads Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_microsoft_ads/)) ## What does this dbt package do? - Produces modeled tables that leverage Microsoft Ads data from [Fivetran's connector](https://fivetran.com/docs/applications/microsoft-advertising) in the format described by [this ERD](https://fivetran.com/docs/applications/microsoft-advertising#schemainformation) and builds off the output of our [Microsoft Ads source package](https://github.com/fivetran/dbt_microsoft_ads_source). - Enables you to better understand the performance of your ads across varying grains: @@ -34,6 +35,8 @@ The following table provides a detailed list of all tables materialized within t | [microsoft_ads__keyword_report](https://fivetran.github.io/dbt_microsoft_ads/#!/model/model.microsoft_ads.microsoft_ads__keyword_report) | Each record in this table represents the daily performance at the ad group level for keywords. | | [microsoft_ads__search_report](https://fivetran.github.io/dbt_microsoft_ads/#!/model/model.microsoft_ads.microsoft_ads__search_report) | Each record in this table represents the daily performance at the search level. | | [microsoft_ads__url_report](https://fivetran.github.io/dbt_microsoft_ads/#!/model/model.microsoft_ads.microsoft_ads__url_report) | Each record in this table represents the daily performance of URLs at the ad level. | +### Materialized Models +Each Quickstart transformation job run materializes 29 models if all components of this data model are enabled. This count includes all staging, intermediate, and final models materialized as `view`, `table`, or `incremental`. ## How do I use the dbt package? @@ -41,7 +44,7 @@ The following table provides a detailed list of all tables materialized within t ### Step 1: Prerequisites To use this dbt package, you must have the following: -- At least one Fivetran Microsoft Ads connector syncing data into your destination. +- At least one Fivetran Microsoft Ads connection syncing data into your destination. - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. #### Databricks Dispatch Configuration @@ -75,8 +78,8 @@ vars: ### (Optional) Step 4: Additional configurations
Expand/Collapse details -#### Union multiple connectors -If you have multiple microsoft_ads 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 into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set either the `microsoft_ads_union_schemas` OR `microsoft_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file: +#### Union multiple connections +If you have multiple microsoft_ads connections 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 into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set either the `microsoft_ads_union_schemas` OR `microsoft_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file: ```yml vars: @@ -133,7 +136,7 @@ models: ``` #### 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. This is not available if you are unioning together multiple connectors. +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. This is not available if you are unioning together multiple connections. > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_microsoft_ads/blob/main/dbt_project.yml) variable declarations to see the expected names. @@ -188,4 +191,4 @@ A special thank you to [Seer Interactive](https://www.seerinteractive.com/?utm_c ## 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_microsoft_ads/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). \ No newline at end of file +- 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).