Standardize unioning macros to use fivetran_utils versions (#19)

* MagicBot/standardize-unioning-macros

* fix base

* yml

* Generate dbt docs via GitHub Actions

* update packages.yml dependency

---------

Co-authored-by: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com>
Co-authored-by: Catherine Fritz <111930712+fivetran-catfritz@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: 4 people

.gitignore

@@ -1,4 +1,5 @@
 # dbt
+worktrees/
 **/package-lock.yml
 package-lock.yml
 .dbt/

CHANGELOG.md

@@ -1,3 +1,21 @@
+# dbt_salesforce_marketing_cloud v0.6.0
+
+[PR #19](https://github.com/fivetran/dbt_salesforce_marketing_cloud/pull/19) includes the following updates:
+
+## Schema/Data Changes (--full-refresh required after upgrading)
+**1 total change • 1 possible breaking change**
+
+| Data Model(s) | Change type | Old | New | Notes |
+| ------------- | ----------- | --- | --- | ----- |
+| All models | `source_relation` column (when using a single Salesforce Marketing Cloud schema) | Empty string (`''`) | `<database>.<schema>` |  |
+
+## Feature Updates
+- Introduces the new (recommended) `salesforce_marketing_cloud_sources` variable for more robust union data configuration. The old `salesforce_marketing_cloud_union_schemas` and `salesforce_marketing_cloud_union_databases` variables will still be supported. See the [README](https://github.com/fivetran/dbt_salesforce_marketing_cloud/tree/main#define-database-and-schema-variables) for specific details.
+
+## Under the Hood
+- Adds the `fivetran_using_source_casing` variable for case-sensitive destination support. When enabled, downstream transformations respect source casing to ensure consistent results. See the [Additional Configurations](https://github.com/fivetran/dbt_salesforce_marketing_cloud/#source-casing-for-case-sensitive-destinations) section of the README for details.
+- Introduces `fivetran_utils.partition_by_source_relation` to conditionally include `source_relation` in partition clauses only when multiple sources are configured.
+
 # dbt_salesforce_marketing_cloud v0.5.1
 
 [PR #16](https://github.com/fivetran/dbt_salesforce_marketing_cloud/pull/16) includes the following updates:

README.md

@@ -75,7 +75,7 @@ Include the following Salesforce Marketing Cloud package version in your `packag
 ```yml
 packages:
   - package: fivetran/salesforce_marketing_cloud
-    version: [">=0.5.0", "<0.6.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=0.6.0", "<0.7.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 
 #### Databricks dispatch configuration
@@ -87,26 +87,40 @@ dispatch:
 ```
 
 ### Define database and schema variables
-#### Single connection
+#### Option A: Single connection
 By default, this package runs using your destination and the `salesforce_marketing_cloud` schema. If this is not where your Salesforce Marketing Cloud data is (for example, if your Salesforce Marketing Cloud schema is named `salesforce_marketing_cloud_fivetran`), add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
 vars:
-    salesforce_marketing_cloud_database: your_database_name
+    salesforce_marketing_cloud_database: your_destination_name
     salesforce_marketing_cloud_schema: your_schema_name
 ```
-#### Union multiple connections
-If you have multiple Salesforce Marketing Cloud 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 `salesforce_marketing_cloud_union_schemas` OR `salesforce_marketing_cloud_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
+
+#### Option B: Union multiple connections
+If you have multiple Salesforce Marketing Cloud connections in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. For each source table, the package will union all of the data together and pass the unioned table into the transformations. The `source_relation` column in each model indicates the origin of each record.
+
+To use this functionality, you will need to set the `salesforce_marketing_cloud_sources` variable in your root `dbt_project.yml` file:
 
 ```yml
+# dbt_project.yml
+
 vars:
-    salesforce_marketing_cloud_union_schemas: ['sfmc_usa','sfmc_canada'] # use this if the data is in different schemas/datasets of the same database/project
-    salesforce_marketing_cloud_union_databases: ['sfmc_usa','sfmc_canada'] # use this if the data is in different databases/projects but uses the same schema name
+  salesforce_marketing_cloud:
+    salesforce_marketing_cloud_sources:
+      - database: connection_1_destination_name # Required
+        schema: connection_1_schema_name # Required
+        name: connection_1_source_name # Required only if following the step in the following subsection
+
+      - database: connection_2_destination_name
+        schema: connection_2_schema_name
+        name: connection_2_source_name
 ```
 
-> NOTE: 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`.
+> Previous versions of this package employed two separate, mutually exclusive variables for unioning: `salesforce_marketing_cloud_union_schemas` and `salesforce_marketing_cloud_union_databases`. While these variables are still supported, `salesforce_marketing_cloud_sources` is the recommended variable to configure.
+
+#### Optional: Incorporate unioned sources into DAG
 
-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.
+If you use [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt#transformationsfordbtcore) and are unioning multiple Salesforce Marketing Cloud connections, you can define your sources in a property `.yml` file, [using this as a template](https://github.com/fivetran/dbt_salesforce_marketing_cloud/blob/main/models/staging/src_salesforce_marketing_cloud.yml). Set the variable `has_defined_sources: true` under the Salesforce Marketing Cloud namespace in your `dbt_project.yml`. Otherwise, your Salesforce Marketing Cloud connections won't appear in your DAG. See the `union_connections` macro [documentation](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#optional-union-connections-defined-sources-configuration) for full configuration details.
 
 ### Enable/Disable Variables
 By default, this package brings in data from the Salesforce Marketing Cloud `link` and `list` source tables. However, if you have disabled syncing these sources, you will need to add the following configuration to your `dbt_project.yml`:
@@ -141,6 +155,14 @@ vars:
     salesforce_marketing_cloud_<default_source_table_name>_identifier: your_table_name 
 ```
 
+#### Source casing for case-sensitive destinations
+By default, the package applies case-insensitive comparisons when resolving `source_relation` values. If your destination is case-sensitive and you want downstream transformations to respect the exact casing of your source database and schema names, set the following variable:
+
+```yml
+vars:
+    fivetran_using_source_casing: true
+```
+
 ### (Optional) Orchestrate your models with Fivetran Transformations for dbt Core™
 <details><summary>Expand for details</summary>
 <br>

dbt_project.yml

@@ -1,6 +1,6 @@
 config-version: 2
 name: 'salesforce_marketing_cloud'
-version: '0.5.1'
+version: '0.6.0'
 require-dbt-version: [">=1.3.0", "<3.0.0"]
 
 models:

docs/catalog.json

@@ -21,4 +21,10 @@ test_scenarios:
     vars:
       salesforce_marketing_cloud__link_enabled: false
       salesforce_marketing_cloud__list_enabled: false
-    include_incremental: true
+    include_incremental: true
+
+  - name: "MDLS"
+    vars:
+      fivetran_using_source_casing: true
+    include_incremental: false
+    include_dbt_seed: true

docs/index.html

@@ -1,5 +1,5 @@
 name: 'salesforce_marketing_cloud_integration_tests'
-version: '0.5.1'
+version: '0.6.0'
 config-version: 2
 
 profile: 'integration_tests'
@@ -25,14 +25,13 @@ models:
   +persist_docs:
     relation: true
     columns: "{{ false if target.type in ('databricks') else true }}" 
-  +schema: "{{ 'sfmc_sqlw_tests' if target.name == 'databricks-sql' else 'salesforce_marketing_cloud' }}"
-  # +schema: "salesforce_marketing_cloud_{{ var('directed_schema','dev') }}" ## To be used for validation testing
+  +schema: "salesforce_marketing_cloud_{{ var('directed_schema','dev') }}" ## To be used for validation testing
 
 seeds:
   +docs:
     show: False
   salesforce_marketing_cloud_integration_tests:
-    +quote_columns: "{{ true if target.type == 'redshift' else false }}"
+    +quote_columns: "{{ target.type == 'redshift' or var('fivetran_using_source_casing', false) }}"
     email_data:
       +column_types: 
         id: "{{ 'string' if target.type in ('bigquery', 'spark', 'databricks') else 'varchar' }}"

docs/manifest.json

@@ -1,12 +1,26 @@
+{% if var('salesforce_marketing_cloud_union_schemas', []) | length > 0 or var('salesforce_marketing_cloud_union_databases', []) | length > 0 %}
+
 {{
     fivetran_utils.union_data(
-        table_identifier='email', 
-        database_variable='salesforce_marketing_cloud_database', 
-        schema_variable='salesforce_marketing_cloud_schema', 
+        table_identifier='email',
+        database_variable='salesforce_marketing_cloud_database',
+        schema_variable='salesforce_marketing_cloud_schema',
         default_database=target.database,
         default_schema='salesforce_marketing_cloud',
         default_variable='email',
         union_schema_variable='salesforce_marketing_cloud_union_schemas',
         union_database_variable='salesforce_marketing_cloud_union_databases'
     )
 }}
+
+{% else %}
+
+{{
+    fivetran_utils.union_connections(
+        connection_dictionary='salesforce_marketing_cloud_sources',
+        single_source_name='salesforce_marketing_cloud',
+        single_table_name='email'
+    )
+}}
+
+{% endif %}