Merge pull request #52 from fivetran/MagicBot/add-union-schema

fivetran-catfritz · web-flow · commit b80753d87065 · 2023-10-12T15:10:06.000-05:00
Feature: Union schema compatibility
diff --git a/.buildkite/hooks/pre-command b/.buildkite/hooks/pre-command
@@ -21,4 +21,5 @@ export CI_SNOWFLAKE_DBT_USER=$(gcloud secrets versions access latest --secret="C
 export CI_SNOWFLAKE_DBT_WAREHOUSE=$(gcloud secrets versions access latest --secret="CI_SNOWFLAKE_DBT_WAREHOUSE" --project="dbt-package-testing-363917")
 export CI_DATABRICKS_DBT_HOST=$(gcloud secrets versions access latest --secret="CI_DATABRICKS_DBT_HOST" --project="dbt-package-testing-363917")
 export CI_DATABRICKS_DBT_HTTP_PATH=$(gcloud secrets versions access latest --secret="CI_DATABRICKS_DBT_HTTP_PATH" --project="dbt-package-testing-363917")
-export CI_DATABRICKS_DBT_TOKEN=$(gcloud secrets versions access latest --secret="CI_DATABRICKS_DBT_TOKEN" --project="dbt-package-testing-363917")
+export CI_DATABRICKS_DBT_TOKEN=$(gcloud secrets versions access latest --secret="CI_DATABRICKS_DBT_TOKEN" --project="dbt-package-testing-363917")
+export CI_DATABRICKS_DBT_CATALOG=$(gcloud secrets versions access latest --secret="CI_DATABRICKS_DBT_CATALOG" --project="dbt-package-testing-363917")
diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml
@@ -69,5 +69,6 @@ steps:
             - "CI_DATABRICKS_DBT_HOST"
             - "CI_DATABRICKS_DBT_HTTP_PATH"
             - "CI_DATABRICKS_DBT_TOKEN"
+            - "CI_DATABRICKS_DBT_CATALOG"
     commands: |
       bash .buildkite/scripts/run_models.sh databricks
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,19 @@
-# dbt_google_ads v0.x.x
-
-[PR #58](https://github.com/fivetran/dbt_google_ads/pull/58) includes the following updates:
-## Under the Hood:
-- Updates the [DECISIONLOG](DECISIONLOG.md) to clarify why there exist differences among aggregations across different grains.
+# dbt_google_ads v0.10.0
+[PR #52](https://github.com/fivetran/dbt_google_ads/pull/52) includes the following updates:
+## Feature update 🎉
+- Unioning capability! This adds the ability to union source data from multiple google_ads connectors. Refer to the [Union Multiple Connectors README section](https://github.com/fivetran/dbt_google_ads/blob/main/README.md#union-multiple-connectors) for more details.
+
+## Under the Hood 🚘
+- In the source package, updated tmp models to union source data using the `fivetran_utils.union_data` macro. 
+- To distinguish which source each field comes from, added `source_relation` column in each staging and downstream model and applied the `fivetran_utils.source_relation` macro. 
+    - The `source_relation` column is included in all joins in the transform package. 
+- Updated tests to account for the new `source_relation` column. 
+
+[PR #60](https://github.com/fivetran/dbt_google_ads/pull/60) includes the following update:
+## Dependency Updates
+- Removes the dependency on `dbt-expectations`. Upstream we specifically removed the `dbt_expectations.expect_column_values_to_not_match_regex_list` test.
+## Under the Hood 
+- Updates the [DECISIONLOG](DECISIONLOG.md) to clarify why there exist differences among aggregations across different grains. 
 
 # dbt_google_ads v0.9.3
 [PR #57](https://github.com/fivetran/dbt_google_ads/pull/57) includes the following updates:
diff --git a/README.md b/README.md
@@ -39,14 +39,11 @@ To use this dbt package, you must have the following:
 - 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` as well as the `calogica/dbt_expectations` then the `google_ads_source` packages respectively.
+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`.
 ```yml
 dispatch:
   - macro_namespace: dbt_utils
     search_order: ['spark_utils', 'dbt_utils']
-
-  - macro_namespace: dbt_expectations
-    search_order: ['google_ads_source', 'dbt_expectations']
 ```
 
 ## Step 2: Install the package
@@ -55,7 +52,7 @@ Include the following google_ads package version in your `packages.yml` file:
 ```yaml
 packages:
   - package: fivetran/google_ads
-    version: [">=0.9.0", "<0.10.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=0.10.0", "<0.11.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 Do **NOT** include the `google_ads_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
 
@@ -70,7 +67,17 @@ vars:
 
 ## (Optional) Step 4: Additional configurations
 
-<details><summary>Expand for configurations</summary>
+### Union multiple connectors
+If you have multiple google_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 `google_ads_union_schemas` OR `google_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
+
+```yml
+vars:
+    google_ads_union_schemas: ['google_ads_usa','google_ads_canada'] # use this if the data is in different schemas/datasets of the same database/project
+    google_ads_union_databases: ['google_ads_usa','google_ads_canada'] # use this if the data is in different databases/projects but uses the same schema name
+```
+Please be aware that the native `source.yml` connection set up in the package will not function when the union schema/database feature is utilized. Although the data will be correctly combined, you will not observe the sources linked to the package models in the Directed Acyclic Graph (DAG). This happens because the package includes only one defined `source.yml`.
+
+To connect your multiple schema/database sources to the package models, follow the steps outlined in the [Union Data Defined Sources Configuration](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#union_data-source) section of the Fivetran Utils documentation for the union_data macro. This will ensure a proper configuration and correct visualization of connections in the DAG.
 
 ### Adding passthrough metrics
 By default, this package will select `clicks`, `impressions`, and `cost` from the source reporting tables to store into the staging models. If you would like to pass through additional metrics to the staging models, add the below configurations to your `dbt_project.yml` file. These variables allow for the pass-through fields to be aliased (`alias`) if desired, but not required. Use the below format for declaring the respective pass-through variables:
@@ -121,8 +128,6 @@ vars:
     google_ads_<default_source_table_name>_identifier: your_table_name 
 ```
 
-</details>
-
 ## (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™    
 <details><summary>Expand for more details</summary>
 
@@ -137,7 +142,7 @@ This dbt package is dependent on the following dbt packages. Please be aware tha
 ```yml
 packages:
     - package: fivetran/google_ads_source
-      version: [">=0.9.0", "<0.10.0"]
+      version: [">=0.10.0", "<0.11.0"]
 
     - package: fivetran/fivetran_utils
       version: [">=0.4.0", "<0.5.0"]
@@ -147,12 +152,6 @@ packages:
 
     - package: dbt-labs/spark_utils
       version: [">=0.3.0", "<0.4.0"]
-
-    - package: calogica/dbt_expectations
-      version: [">=0.8.0", "<0.9.0"]
-
-    - package: calogica/dbt_date
-      version: [">=0.7.0", "<0.8.0"]
 ```
 # 🙌 How is this package maintained and can I contribute?
 ## Package Maintenance
diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'google_ads'
-version: '0.9.3'
+version: '0.10.0'
 
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
diff --git a/docs/catalog.json b/docs/catalog.json
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/run_results.json b/docs/run_results.json
diff --git a/integration_tests/ci/sample.profiles.yml b/integration_tests/ci/sample.profiles.yml
@@ -44,10 +44,10 @@ integration_tests:
       schema: google_ads_integration_tests_31
       threads: 8
     databricks:
-      catalog: null
+      catalog: "{{ env_var('CI_DATABRICKS_DBT_CATALOG') }}"
       host: "{{ env_var('CI_DATABRICKS_DBT_HOST') }}"
       http_path: "{{ env_var('CI_DATABRICKS_DBT_HTTP_PATH') }}"
       schema: google_ads_integration_tests_31
-      threads: 2
+      threads: 8
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
       type: databricks
diff --git a/integration_tests/dbt_project.yml b/integration_tests/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'google_ads_integration_tests'
-version: '0.9.3'
+version: '0.10.0'
 
 profile: 'integration_tests'
 config-version: 2
@@ -33,6 +33,3 @@ seeds:
 dispatch:
   - macro_namespace: dbt_utils
     search_order: ['spark_utils', 'dbt_utils']
-
-  - macro_namespace: dbt_expectations
-    search_order: ['google_ads_source', 'dbt_expectations']
diff --git a/integration_tests/requirements.txt b/integration_tests/requirements.txt
@@ -4,4 +4,6 @@ dbt-redshift>=1.3.0,<2.0.0
 dbt-postgres>=1.3.0,<2.0.0
 dbt-spark>=1.3.0,<2.0.0
 dbt-spark[PyHive]>=1.3.0,<2.0.0
-dbt-databricks>=1.3.0,<2.0.0
+dbt-databricks>=1.3.0,<2.0.0
+
+oscrypto @ git+https://github.com/wbond/oscrypto.git@d5f3437
diff --git a/models/google_ads.yml b/models/google_ads.yml
@@ -6,13 +6,16 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - ad_id
             - ad_group_id
             - date_day
           config:
             # Below is so we don't run this test if the user has allowed urls to have null entries
             enabled: "{{ var('ad_reporting__url_report__using_null_filter', true) }}"
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
@@ -64,9 +67,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - account_id
             - date_day
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
@@ -93,9 +99,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - ad_group_id
             - date_day
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
@@ -130,10 +139,13 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - ad_id
             - ad_group_id
             - date_day
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
@@ -174,11 +186,14 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - campaign_id
             - advertising_channel_type
             - advertising_channel_subtype
             - date_day
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
@@ -211,10 +226,13 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - ad_group_id
             - criterion_id
             - date_day
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date') }}"
       - name: account_name
diff --git a/models/google_ads__account_report.sql b/models/google_ads__account_report.sql
@@ -16,6 +16,7 @@ accounts as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         stats.account_id,
@@ -31,7 +32,8 @@ fields as (
     from stats
     left join accounts
         on stats.account_id = accounts.account_id
-    {{ dbt_utils.group_by(6) }}
+        and stats.source_relation = accounts.source_relation
+    {{ dbt_utils.group_by(7) }}
 )
 
 select *
diff --git a/models/google_ads__ad_group_report.sql b/models/google_ads__ad_group_report.sql
@@ -30,6 +30,7 @@ ad_groups as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         accounts.account_id,
@@ -49,11 +50,14 @@ fields as (
     from stats
     left join ad_groups
         on stats.ad_group_id = ad_groups.ad_group_id
+        and stats.source_relation = ad_groups.source_relation
     left join campaigns
         on ad_groups.campaign_id = campaigns.campaign_id
+        and ad_groups.source_relation = campaigns.source_relation
     left join accounts
         on campaigns.account_id = accounts.account_id
-    {{ dbt_utils.group_by(10) }}
+        and campaigns.source_relation = accounts.source_relation
+    {{ dbt_utils.group_by(11) }}
 )
 
 select *
diff --git a/models/google_ads__ad_report.sql b/models/google_ads__ad_report.sql
@@ -37,6 +37,7 @@ ads as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         accounts.account_id,
@@ -60,14 +61,18 @@ fields as (
     from stats
     left join ads
         on stats.ad_id = ads.ad_id
+        and stats.source_relation = ads.source_relation
         and stats.ad_group_id = ads.ad_group_id
     left join ad_groups
         on ads.ad_group_id = ad_groups.ad_group_id
+        and ads.source_relation = ad_groups.source_relation
     left join campaigns
         on ad_groups.campaign_id = campaigns.campaign_id
+        and ad_groups.source_relation = campaigns.source_relation
     left join accounts
         on campaigns.account_id = accounts.account_id
-    {{ dbt_utils.group_by(14) }}
+        and campaigns.source_relation = accounts.source_relation
+    {{ dbt_utils.group_by(15) }}
 )
 
 select *
diff --git a/models/google_ads__campaign_report.sql b/models/google_ads__campaign_report.sql
@@ -23,6 +23,7 @@ campaigns as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         accounts.account_id,
@@ -41,9 +42,11 @@ fields as (
     from stats
     left join campaigns
         on stats.campaign_id = campaigns.campaign_id
+        and stats.source_relation = campaigns.source_relation
     left join accounts
         on campaigns.account_id = accounts.account_id
-    {{ dbt_utils.group_by(9) }}
+        and campaigns.source_relation = accounts.source_relation
+    {{ dbt_utils.group_by(10) }}
 )
 
 select *
diff --git a/models/google_ads__keyword_report.sql b/models/google_ads__keyword_report.sql
@@ -37,6 +37,7 @@ criterions as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         stats.account_id,
@@ -59,13 +60,17 @@ fields as (
     from stats
     left join criterions
         on stats.criterion_id = criterions.criterion_id
+        and stats.source_relation = criterions.source_relation
     left join ad_groups
         on stats.ad_group_id = ad_groups.ad_group_id
+        and stats.source_relation = ad_groups.source_relation
     left join campaigns
         on stats.campaign_id = campaigns.campaign_id
+        and stats.source_relation = campaigns.source_relation
     left join accounts
         on stats.account_id = accounts.account_id
-    {{ dbt_utils.group_by(13) }}
+        and stats.source_relation = accounts.source_relation
+    {{ dbt_utils.group_by(14) }}
 )
 
 select *
diff --git a/models/google_ads__url_report.sql b/models/google_ads__url_report.sql
@@ -37,6 +37,7 @@ ads as (
 fields as (
 
     select
+        stats.source_relation,
         stats.date_day,
         accounts.account_name,
         accounts.account_id,
@@ -76,19 +77,23 @@ fields as (
     from stats
     left join ads
         on stats.ad_id = ads.ad_id
+        and stats.source_relation = ads.source_relation
         and stats.ad_group_id = ads.ad_group_id
     left join ad_groups
         on ads.ad_group_id = ad_groups.ad_group_id
+        and ads.source_relation = ad_groups.source_relation
     left join campaigns
         on ad_groups.campaign_id = campaigns.campaign_id
+        and ad_groups.source_relation = campaigns.source_relation
     left join accounts
         on campaigns.account_id = accounts.account_id
+        and campaigns.source_relation = accounts.source_relation
 
     {% if var('ad_reporting__url_report__using_null_filter', True) %}
         where ads.source_final_urls is not null
     {% endif %}
 
-    {{ dbt_utils.group_by(17) }}
+    {{ dbt_utils.group_by(18) }}
 )
 
 select *
diff --git a/packages.yml b/packages.yml
