Feature: Union schema compatibility

.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")

.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

CHANGELOG.md

@@ -1,3 +1,13 @@
+# dbt_pinterest_source v0.10.0
+[PR #28](https://github.com/fivetran/dbt_pinterest_source/pull/28) includes the following updates:
+## Feature update 🎉
+- Unioning capability! This adds the ability to union source data from multiple pinterest connectors. Refer to the [README](https://github.com/fivetran/dbt_pinterest_source/blob/main/README.md) for more details.
+
+## Under the hood 🚘
+- 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 model and applied the `fivetran_utils.source_relation` macro.
+- Updated tests to account for the new `source_relation` column.
+
 # dbt_pinterest_source v0.9.0
 # Pinterest Ads v5 Upgrade
 ## 🚨 Breaking Changes 🚨:

README.md

@@ -39,7 +39,7 @@ If you  are **not** using the [Pinterest transformation package](https://github.
 ```yaml
 packages:
   - package: fivetran/pinterest_source
-    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
 ```
 ## Step 3: Define database and schema variables
 By default, this package runs using your destination and the `pinterest` schema. If this is not where your Pinterest Ads data is (for example, if your pinterest schema is named `pinterest_fivetran`), add the following configuration to your root `dbt_project.yml` file:
@@ -60,6 +60,18 @@ vars:
 ## (Optional) Step 5: Additional configurations
 <details><summary>Expand for configurations</summary>
 
+### Union multiple connectors
+If you have multiple pinterest 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 `pinterest_ads_union_schemas` OR `pinterest_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
+
+```yml
+vars:
+    pinterest_ads_union_schemas: ['pinterest_usa','pinterest_canada'] # use this if the data is in different schemas/datasets of the same database/project
+    pinterest_ads_union_databases: ['pinterest_usa','pinterest_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.
+
 ### Passing Through Additional 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:
 

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'pinterest_source'
-version: '0.9.0'
+version: '0.10.0'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 vars:

integration_tests/ci/sample.profiles.yml

@@ -16,13 +16,13 @@ integration_tests:
       pass: "{{ env_var('CI_REDSHIFT_DBT_PASS') }}"
       dbname: "{{ env_var('CI_REDSHIFT_DBT_DBNAME') }}"
       port: 5439
-      schema: pinterest_source_integration_tests
+      schema: pinterest_source_integration_tests_3
       threads: 8
     bigquery:
       type: bigquery
       method: service-account-json
       project: 'dbt-package-testing'
-      schema: pinterest_source_integration_tests
+      schema: pinterest_source_integration_tests_3
       threads: 8
       keyfile_json: "{{ env_var('GCLOUD_SERVICE_KEY') | as_native }}"
     snowflake:
@@ -33,7 +33,7 @@ integration_tests:
       role: "{{ env_var('CI_SNOWFLAKE_DBT_ROLE') }}"
       database: "{{ env_var('CI_SNOWFLAKE_DBT_DATABASE') }}"
       warehouse: "{{ env_var('CI_SNOWFLAKE_DBT_WAREHOUSE') }}"
-      schema: pinterest_source_integration_tests
+      schema: pinterest_source_integration_tests_3
       threads: 8
     postgres:
       type: postgres
@@ -42,13 +42,13 @@ integration_tests:
       pass: "{{ env_var('CI_POSTGRES_DBT_PASS') }}"
       dbname: "{{ env_var('CI_POSTGRES_DBT_DBNAME') }}"
       port: 5432
-      schema: pinterest_source_integration_tests
+      schema: pinterest_source_integration_tests_3
       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: pinterest_source_integration_tests
-      threads: 2
+      schema: pinterest_source_integration_tests_3
+      threads: 8
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
       type: databricks

integration_tests/dbt_project.yml

@@ -1,10 +1,10 @@
 name: 'pinterest_source_integration_tests'
-version: '0.9.0'
+version: '0.10.0'
 profile: 'integration_tests'
 config-version: 2
 
 vars:
-  pinterest_schema: pinterest_source_integration_tests
+  pinterest_schema: pinterest_source_integration_tests_4
   pinterest_ad_group_history_identifier: "pinterest_ad_group_history_data"
   pinterest_campaign_history_identifier: "pinterest_campaign_history_data"
   pinterest_pin_promotion_history_identifier: "pinterest_pin_promotion_history_data"
@@ -16,6 +16,11 @@ vars:
   pinterest_advertiser_history_identifier: "pinterest_advertiser_history_data"
   pinterest_advertiser_report_identifier: "pinterest_advertiser_report_data"
 
+models:
+  pinterest_source:
+    tmp:
+      +materialized: table
+
 seeds:
   +quote_columns: "{{ true if target.type in ('redshift','postgres') else false }}"
   pinterest_source_integration_tests:

models/docs.md

@@ -32,4 +32,6 @@
 
 {% docs impression_1 %} The number of paid pin impressions that occurred on the day of the record. {% enddocs %}
 
-{% docs impression_2 %} The number of earned pin impressions that occurred on the day of the record. {% enddocs %}
+{% docs impression_2 %} The number of earned pin impressions that occurred on the day of the record. {% enddocs %}
+
+{% docs source_relation %}The source of the record if the unioning functionality is being used. If not this field will be empty.{% enddocs %}

models/src_pinterest_ads.yml

@@ -1,7 +1,7 @@
 version: 2
 
 sources:
-  - name: pinterest_ads
+  - name: pinterest_ads # This source will only be used if you are using a single microsoft_ads source connector. If multiple sources are being unioned, their tables will be directly referenced via adapter.get_relation.
     schema: "{{ var('pinterest_schema', 'pinterest_ads') }}"
     database: "{% if target.type != 'spark'%}{{ var('pinterest_database', target.database) }}{% endif %}"
 

models/stg_pinterest_ads.yml

@@ -6,9 +6,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - ad_group_id
             - _fivetran_synced
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: ad_group_id
         description: Ad group ID.
         tests:
@@ -43,9 +46,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - campaign_id
             - _fivetran_synced
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: campaign_id
         description: "{{ doc('campaign_id') }}"
         tests:
@@ -76,9 +82,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - _fivetran_synced
             - pin_promotion_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: pin_promotion_id
         description: Pin promotion ID.
         tests:
@@ -128,12 +137,15 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - date_day
             - pin_promotion_id
             - ad_group_id
             - campaign_id
             - advertiser_id
-    columns: 
+    columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date_day') }}"
         tests:
@@ -160,11 +172,14 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - date_day
             - ad_group_id
             - campaign_id
             - advertiser_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date_day') }}"
         tests:
@@ -193,9 +208,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - updated_at
             - advertiser_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: advertiser_id
         description: "{{ doc('advertiser_id') }}"
         tests:
@@ -224,9 +242,12 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - date_day
             - advertiser_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date_day') }}"
         tests:
@@ -247,10 +268,13 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - date_day
             - campaign_id
             - advertiser_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date_day') }}"
         tests:
@@ -277,10 +301,13 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - keyword_id
             - ad_group_id
             - _fivetran_synced
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: keyword_id
         description: Unique identifier of the keyword.
         tests:
@@ -313,13 +340,16 @@ models:
     tests:
       - dbt_utils.unique_combination_of_columns:
           combination_of_columns:
+            - source_relation
             - date_day
             - keyword_id
             - pin_promotion_id
             - ad_group_id
             - campaign_id
             - advertiser_id
     columns:
+      - name: source_relation
+        description: "{{ doc('source_relation') }}"
       - name: date_day
         description: "{{ doc('date_day') }}"
         tests:

models/stg_pinterest_ads__ad_group_history.sql

@@ -15,12 +15,19 @@ fields as (
                 staging_columns=get_ad_group_history_columns()
             )
         }}
+
+        {{ fivetran_utils.source_relation(
+            union_schema_variable='pinterest_ads_union_schemas', 
+            union_database_variable='pinterest_ads_union_databases') 
+        }}
+
     from base
 ),
 
 final as (
 
     select
+        source_relation,
         id as ad_group_id,
         name as ad_group_name,
         status as ad_group_status,
@@ -33,7 +40,7 @@ final as (
         placement_group,
         start_time,
         summary_status,
-        row_number() over (partition by id order by _fivetran_synced desc) = 1 as is_most_recent_record
+        row_number() over (partition by source_relation, id order by _fivetran_synced desc) = 1 as is_most_recent_record
     from fields
 )
 

models/stg_pinterest_ads__ad_group_report.sql

@@ -15,12 +15,19 @@ fields as (
                 staging_columns=get_ad_group_report_columns()
             )
         }}
+
+        {{ fivetran_utils.source_relation(
+            union_schema_variable='pinterest_ads_union_schemas', 
+            union_database_variable='pinterest_ads_union_databases') 
+        }}
+
     from base
 ),
 
 final as (
-
-    select 
+
+    select
+        source_relation, 
         {{ dbt.date_trunc('day', 'date') }} as date_day,
         ad_group_id,
         ad_group_name,

models/stg_pinterest_ads__advertiser_history.sql

@@ -15,12 +15,19 @@ fields as (
                 staging_columns=get_advertiser_history_columns()
             )
         }}
+
+        {{ fivetran_utils.source_relation(
+            union_schema_variable='pinterest_ads_union_schemas', 
+            union_database_variable='pinterest_ads_union_databases') 
+        }}
+
     from base
 ),
 
 final as (
-
-    select 
+
+    select
+        source_relation, 
         id as advertiser_id,
         name as advertiser_name,
         country,
@@ -30,7 +37,7 @@ final as (
         owner_username,
         advertiser_permissions, -- permissions was renamed in macro
         updated_time as updated_at,
-        row_number() over (partition by id order by updated_time desc) = 1 as is_most_recent_record
+        row_number() over (partition by source_relation, id order by updated_time desc) = 1 as is_most_recent_record
     from fields
 )
 

models/stg_pinterest_ads__advertiser_report.sql

@@ -15,12 +15,19 @@ fields as (
                 staging_columns=get_advertiser_report_columns()
             )
         }}
+
+        {{ fivetran_utils.source_relation(
+            union_schema_variable='pinterest_ads_union_schemas', 
+            union_database_variable='pinterest_ads_union_databases') 
+        }}
+
     from base
 ),
 
 final as (
-
-    select 
+
+    select
+        source_relation, 
         {{ dbt.date_trunc('day', 'date') }} as date_day,
         advertiser_id,
         coalesce(impression_1,0) + coalesce(impression_2,0) as impressions,