Releases: fivetran/dbt_shopify_holistic_reporting
v1.2.0 dbt_shopify_holistic_reporting
PR #40 includes the following updates:
Schema/Data Changes (--full-refresh required after upgrading)
4 total changes • 2 possible breaking changes
| Data Model(s) | Change type | Old | New | Notes |
|---|---|---|---|---|
| shopify_holistic_reporting__customer_enhanced | Data change (Breaking Change) | shopify_lifetime_total_discount and shopify_avg_discount_per_order sourced from order_line.total_discount |
Now sourced from discount_allocation |
Values for these fields are likely to change. discount_allocation is the more reliable source for order line discount values. |
| shopify_holistic_reporting__daily_customer_metrics | Data change (Breaking Change) | shopify_total_discounts sourced from Shopify API total_discounts field |
Now sourced from discount_allocation |
Values for this field are likely to change. The upstream Shopify package replaced the API-level total_discounts field with discount allocation logic, which is more reliable for finance reporting. |
| shopify_holistic_reporting__orders_attribution | New columns | gross_sales, discounts, returns, net_sales |
New finance metrics surfaced from the upstream shopify__orders model. |
|
| shopify_holistic_reporting__daily_customer_metrics | New columns | shopify_total_gross_sales, shopify_total_returns, shopify_total_net_sales |
New daily finance metric aggregates. |
Upstream Dependency Changes
- Increases the required Shopify package to version 1.7.0. Refer to the dbt_shopify CHANGELOG for the full scope of upstream changes, including new refund and return models from version 1.6.0.
Bug Fixes
- Updated window functions in
shopify_holistic_reporting__orders_attributionto partition byorder_idandsource_relation. Previously, in multi-source union setups, orders from different Shopify sources sharing the sameorder_idcould be incorrectly grouped, resulting in wrong last-touch event selection and inflated campaign/flow interaction counts.
Under the Hood
- Added the
partition_by_source_relationmacro, which conditionally appendssource_relationto a window function'sPARTITION BYclause when multiple Shopify or Klaviyo sources are unioned. This centralizes multi-source partitioning logic and avoids repeating the union variable check across models. - Added a DECISIONLOG entry documenting the
source_relationpartitioning behavior and the intentional omission ofsource_relationfrom the deduplication window inint__klaviyo_person_rollup.
Full Changelog: v1.1.0...v1.2.0
v1.1.0 dbt_shopify_holistic_reporting
PR #37 includes the following updates:
Documentation
- Updates README with standardized Fivetran formatting.
Upstream Dependency Changes
- Increases the required Shopify package to version 1.5.0.
- Increases the required Klaviyo package to version 1.3.0.
Full Changelog: v1.0.0...v1.1.0
v1.0.0 dbt_shopify_holistic_reporting
PR #35 includes the following updates:
Breaking Changes (--full-refresh required after upgrading)
- Increases the upstream
dbt_shopifydependency from[">=0.21.0", "<0.22.0"]→[">=1.4.0", "<1.5.0"]. Refer to the below Shopify releases to understand the full scope of changes: - Increases the upstream
dbt_klaviyodependency from[">=1.0.0", "<1.1.0"]→[">=1.2.0", "<1.3.0"]. Refer to the below Klaviyo releases to understand the full scope of changes:
Feature Update
- Adds support for Shopify GraphQL API alongside existing REST API support. Models now dynamically reference the appropriate upstream tables based on the
shopify_apivariable, which is eitherrest(default) orgraphql.
Under the Hood
- Increases the required dbt version upper limit to v3.0.0.
- Removes conditional compilation logic for
shopify__using_order_line_refund,shopify__using_refund, andshopify__using_order_adjustmentvariables inint__daily_shopify_customer_orders. These columns are now always included in the aggregation. - Adds missing Shopify variables to the
quickstart.ymlfile. - Updates Buildkite steps and seed files to adequately test the GraphQL schema.
Full Changelog: v0.9.0...v1.0.0
v0.9.0 dbt_shopify_holistic_reporting
PR #33 includes the following updates:
dbt Fusion Compatibility Updates
- Updated package to maintain compatibility with dbt-core versions both before and after v1.10.6, which introduced a breaking change to multi-argument test syntax (e.g.,
unique_combination_of_columns). - Temporarily removed unsupported tests to avoid errors and ensure smoother upgrades across different dbt-core versions. These tests will be reintroduced once a safe migration path is available.
- Removed all
dbt_utils.unique_combination_of_columnstests.
- Removed all
Upstream Dependency Changes
- Increased the
dbt_klaviyodependency from[">=0.9.0", "<0.10.0"]->[">=1.0.0", "<1.1.0"]. Refer to the below Klaviyo releases to understand the full scope of changes. - Increased the
dbt_shopifydependency from[">=0.11.0", "<0.14.0"]->[">=0.21.0", "<0.22.0"]. Refer to the below Shopify releases to understand the full scope of changes.
Under the Hood
- Updated conditions in
.github/workflows/auto-release.yml. - Added
.github/workflows/generate-docs.yml.
Full Changelog: v0.8.0...v0.9.0
v0.8.0 dbt_shopify_holistic_reporting
PR #30 includes the following updates:
Breaking Change for dbt Core < 1.9.6
Note: This is not relevant to Fivetran Quickstart users.
Migrated freshness from a top-level source property to a source config in alignment with recent updates from dbt Core (Klaviyo Source v0.8.0). This will resolve the following deprecation warning that users running dbt >= 1.9.6 may have received:
[WARNING]: Deprecated functionality
Found `freshness` as a top-level property of `klaviyo` in file
`models/src_klaviyo.yml`. The `freshness` top-level property should be moved
into the `config` of `klaviyo`.
IMPORTANT: Users running dbt Core < 1.9.6 will not be able to utilize freshness tests in this release or any subsequent releases, as older versions of dbt will not recognize freshness as a source config and therefore not run the tests.
If you are using dbt Core < 1.9.6 and want to continue running Klaviyo freshness tests, please elect one of the following options:
- (Recommended) Upgrade to dbt Core >= 1.9.6
- Do not upgrade your installed version of the
klaviyo_sourcepackage. Pin your dependency on v0.13.0 in yourpackages.ymlfile. - Utilize a dbt override to overwrite the package's
klaviyosource and apply freshness via the previous release top-level property route. This will require you to copy and paste the entirety of the previous releasesrc_klaviyo.ymlfile and add anoverrides: klaviyo_sourceproperty.
Documentation
- Added Quickstart model counts to README. (#28)
- Corrected references to connectors and connections in the README. (#28)
Under the Hood
- Updates to ensure integration tests use latest version of dbt.
Full Changelog: v0.7.0...v0.8.0
v0.7.0 dbt_shopify_holistic_reporting
PR #26 includes the following changes:
Upstream Klaviyo and Shopify Holistic Reporting Breaking Changes (Full refresh required after upgrading)
- Upstream and immediate incremental models within the dbt_klaviyo and dbt_shopify_holistic_reporting packages running on BigQuery have had the
partition_bylogic removed. This change affects only BigQuery warehouses and resolves thetoo many partitionserror that some users encountered. The partitioning was also deemed unnecessary for the aforementioned models and their downstream references, offering no performance benefit. By removing it, we eliminate both the error risk and an unneeded configuration. Refer to the v0.8.0 dbt_klaviyo release notes for more details regarding the upstream changes. This change applies to the following models:int_klaviyo__event_attributionklaviyo__eventsshopify_holistic_reporting__orders_attribution
Under the Hood
- Added consistency validation tests for the following models:
shopify_holistic_reporting__customer_enhancedshopify_holistic_reporting__daily_customer_metricsshopify_holistic_reporting__orders_attribution
- Cleaned up unnecessary variable configuration within the
integration_tests/dbt_project.ymlfile.
Full Changelog: v0.6.0...v0.7.0
v0.6.0 dbt_shopify_holistic_reporting
PR #21 includes the following changes:
Dependency Updates
Updates the underlying Shopify package version range from [">=0.10.0", "<0.11.0"] to [">=0.11.0", "<0.14.0"] to account for breaking changes introduced to the Shopify package up to v0.14.0. This wider range will accommodate previous versions while supporting an upcoming release to Shopify, which will not have breaking changes for this package.
- Additionally, please note that the wider range for the Shopify dbt package also updates the underlying Shopify Source dependency range from versions [">=0.10.0", "<0.11.0"] to [">=0.11.0", "<0.13.0"].
Under The Hood
- Included auto-releaser GitHub Actions workflow to automate future releases.
Full Changelog: v0.5.0...v0.6.0
v0.5.0 dbt_shopify_holistic_reporting
PR #18 includes the following changes:
🚨 Breaking Changes 🚨:
- This package now points to the following ranges of the upstream packages. We recommend a
dbt run --full-refreshto capture all the latest data within incremental models.
- package: fivetran/shopify
version: [">=0.10.0", "<0.11.0"]
- package: fivetran/klaviyo
version: [">=0.7.0", "<0.8.0"]
For more information on the changes in the underlying upstream pacakges, refer to the changelogs for Shopify and Klaviyo.
Additions
- Adds field
last_touch_integration_idtoshopify_holistic_reporting__orders_attribution
Under the Hood:
- Replace seed files with the new ones from the respective upstream packages.
- Renamed all Klaviyo seed files so that they start with prefix
klaviyoin order to differentiate which seed files come from Shopify versus Klaviyo. - Removed the flow_snowflake seed file now that
triggerhas been removed from the Klaviyo flow object and as such will not cause run errors in Snowflake. - Populate the order_line_refund seed file as it was empty previously.
Full Changelog: v0.4.0...v0.5.0
v0.4.0 dbt_shopify_holistic_reporting
PR #16 includes the following changes:
🚨 Breaking Changes 🚨:
- The package now points to v0.8.1 of the
shopifypackage.
Bug Fixes:
- Adds flow, campaign, and variation to the join between shopify and klaviyo data in
shopify_holistic_reporting__daily_customer_metrics. These fields are part of the grain of this model and could cause fanout if not included as arguments in thefull outer join.
Under the Hood:
- Updates our README for easier navigation and consistency with other packages.
- Incorporates the new
fivetran_utils.drop_schemas_automationmacro into the end of each Buildkite integration test job. (#15) - Updates the pull request templates. (#15)
Contributors
Related-Package Releases
Full Changelog: v0.3.0...v0.4.0
dbt_shopify_holistic_reporting v0.3.0
🚨 Breaking Changes 🚨:
PR #11 includes the following breaking changes:
- Dispatch update for dbt-utils to dbt-core cross-db macros migration. Specifically
{{ dbt_utils.<macro> }}have been updated to{{ dbt.<macro> }}for the below macros:any_valuebool_orcast_bool_to_textconcatdate_truncdateadddatediffescape_single_quotesexcepthashintersectlast_daylengthlistaggpositionreplacerightsafe_castsplit_partstring_literaltype_biginttype_floattype_inttype_numerictype_stringtype_timestamparray_appendarray_concatarray_construct
- For
current_timestampandcurrent_timestamp_in_utcmacros, the dispatch AND the macro names have been updated to the below, respectively:dbt.current_timestamp_backcompatdbt.current_timestamp_in_utc_backcompat
dbt_utils.surrogate_keyhas also been updated todbt_utils.generate_surrogate_key. Since the method for creating surrogate keys differ, we suggest all users do afull-refreshfor the most accurate data. For more information, please refer to dbt-utils release notes for this update.- Dependencies on
fivetran/fivetran_utilshave been upgraded, previously[">=0.3.0", "<0.4.0"]now[">=0.4.0", "<0.5.0"].