Pre-release with GraphQL as the default

.quickstart/quickstart.yml

@@ -44,16 +44,16 @@ destination_configurations:
         search_order: [ 'spark_utils', 'dbt_utils' ]
 
 public_models: [
-  "shopify__customer_email_cohorts",
-  "shopify__customer_cohorts",
-  "shopify__discounts",
-  "shopify__customer_emails",
-  "shopify__inventory_levels",
-  "shopify__orders",
-  "shopify__daily_shop",
-  "shopify__products",
-  "shopify__transactions",
-  "shopify__customers",
-  "shopify__order_lines",
-  "shopify__line_item_enhanced"
+  "shopify_gql__customer_email_cohorts",
+  "shopify_gql__customer_cohorts",
+  "shopify_gql__discounts",
+  "shopify_gql__customer_emails",
+  "shopify_gql__inventory_levels",
+  "shopify_gql__orders",
+  "shopify_gql__daily_shop",
+  "shopify_gql__products",
+  "shopify_gql__transactions",
+  "shopify_gql__customers",
+  "shopify_gql__order_lines",
+  "shopify_gql__line_item_enhanced"
 ]

CHANGELOG.md

@@ -1,3 +1,17 @@
+# dbt_shopify v0.21.2-a1
+
+[PR #115](https://github.com/fivetran/dbt_shopify/pull/115) introduces the following changes:
+
+## Feature Update
+This pre-release ensures that the GraphQL API-based models are run by default, rather than the REST API ones. It therefore updates the default value of the `shopify_api` [variable](https://github.com/fivetran/dbt_shopify?tab=readme-ov-file#step-3-define-rest-api-or-graphql-api-source) to be `graphql` instead of its original `rest` value.
+
+This release is intended to be used by Fivetran Quickstart users who cannot manually adjust the `shopify_api` variable value and have GraphQL Shopify connections.
+
+> This pre-release merges updates from [v0.21.0](https://github.com/fivetran/dbt_shopify/blob/update/graphql/CHANGELOG.md#dbt_shopify-v0210) and [v0.21.1](https://github.com/fivetran/dbt_shopify/blob/update/graphql/CHANGELOG.md#dbt_shopify-v0211) into the pre-existing [v0.21.0-a1](https://github.com/fivetran/dbt_shopify/blob/update/graphql/CHANGELOG.md#dbt_shopify_source-v0200-a1) version.
+
+## Under the Hood
+With the above in mind, we have updated the `public_models` config in the `quickstart.yml` file to reflect the GraphQL end models only.
+
 # dbt_shopify v0.21.1
 
 [PR #119](https://github.com/fivetran/dbt_shopify/pull/119) includes the following updates:
@@ -19,6 +33,18 @@
   - Removed all `dbt_utils.unique_combination_of_columns` tests.
   - Removed all `accepted_values` tests.
 
+# dbt_shopify_source v0.21.0-a1
+
+[PR #115](https://github.com/fivetran/dbt_shopify_source/pull/114) introduces the following changes:
+
+## Feature Update
+This pre-release adjusts v0.20.0 so that the GraphQL API-based models are run by default, rather than the REST API ones. It therefore updates the default value of the `shopify_api` [variable](https://github.com/fivetran/dbt_shopify?tab=readme-ov-file#step-3-define-rest-api-or-graphql-api-source) to be `graphql` instead of its original `rest` value.
+
+This release is intended to be used by Fivetran Quickstart users who cannot manually adjust the `shopify_api` variable value and have GraphQL Shopify connections.
+
+## Under the Hood
+With the above in mind, we have updated the `public_models` config in the `quickstart.yml` file to reflect the GraphQL end models only.
+
 # dbt_shopify v0.20.0
 
 [PR #113](https://github.com/fivetran/dbt_shopify/pull/113) introduces the following updates:

README.md

@@ -158,7 +158,7 @@ If you are **not** using the [Shopify Holistic reporting package](https://github
 ```yml
 packages:
   - package: fivetran/shopify
-    version: [">=0.21.0", "<0.22.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: 0.21.2-a1
 ```
 
 Do **NOT** include the `shopify_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
@@ -174,13 +174,13 @@ dispatch:
 ### Step 3: Define REST API or GraphQL API Source
 Fivetran has released a version of the Shopify connector that leverages Shopify's newer [GraphQL](https://shopify.dev/docs/apps/build/graphql) API instead of the REST API, as Shopify deprecated the REST API in October 2024. The GraphQL and REST API-based schemas are slightly different, so this package is designed to run either or, not both. It will do so based on the value of the `shopify_api` variable.
 
-By default, `shopify_api` is set to `rest` and will run the `shopify__*` models in the [rest](https://github.com/fivetran/dbt_shopify/tree/main/models/rest) folder. If you would like to run the package on a GraphQL-based schema, adjust `shopify_api` accordingly. This will run the `shopify_gql__*` models in the [graphql](https://github.com/fivetran/dbt_shopify/tree/main/models/graphql) folder:
+By default for this `v0.21.2-a1` release, `shopify_api` is set to `graphql` and will run the `shopify_gql__*` models in the [graphql](https://github.com/fivetran/dbt_shopify/tree/main/models/graphql) folder. If you would like to run the package on a REST-based schema, adjust `shopify_api` accordingly or use [`v0.21.1`](https://github.com/fivetran/dbt_shopify/releases/tag/v0.21.1) of this package. This will run the `shopify__*` models in the [rest](https://github.com/fivetran/dbt_shopify/tree/main/models/rest) folder:
 
 > This variable is dynamically configured for you in Fivetran Quickstart based on your Shopify connection details.
 
 ```yml
 vars:
-  shopify_api: graphql # By default = rest. Must be lowercase
+  shopify_api: rest # By default = grahql. Must be lowercase
 ```
 
 Overall, the package aims for parity across the different API versions and aligns column names with their REST names, **if the fields are supported in GraphQL**. There will be a 1:1 relationship between REST API and GraphQL based end models, but please note that the following source tables are not present in GraphQL and will therefore not be included in any transformations:
@@ -392,7 +392,7 @@ This dbt package is dependent on the following dbt packages. These dependencies
 ```yml
 packages:
     - package: fivetran/shopify_source
-      version: [">=0.20.0", "<0.21.0"]
+      version: 0.20.1-a1
 
     - package: fivetran/fivetran_utils
       version: [">=0.4.0", "<0.5.0"]

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'shopify'
-version: '0.21.1'
+version: '0.21.2'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 models:
@@ -29,6 +29,8 @@ models:
 
 vars:
   shopify:
+    shopify_api: graphql # rest on official release
+
     shopify_customer: "{{ ref('stg_shopify__customer') }}"
     shopify_order: "{{ ref('stg_shopify__order') }}"
     shopify_order_line: "{{ ref('stg_shopify__order_line') }}"

integration_tests/dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'shopify_integration_tests'
-version: '0.21.1'
+version: '0.21.2'
 profile: 'integration_tests'
 config-version: 2
 
@@ -21,6 +21,7 @@ vars:
 
   shopify_schema: shopify_integration_tests_17
   shopify_api_override: rest
+  shopify_api: rest # so Buildkite will still run both sets of models
 
   shopify_source:
     shopify_customer_identifier: "shopify_customer_data"

packages.yml

@@ -1,3 +1,3 @@
 packages:
   - package: fivetran/shopify_source
-    version: [">=0.20.0", "<0.21.0"]
+    version: 0.20.1-a1