Skip to content

Commit

Permalink
Feature: Add Quickstart Model Counts to README (#96)
Browse files Browse the repository at this point in the history
* MagicBot/add-model-counts updates

* Update README.md

---------

Co-authored-by: Avinash Kunnath <[email protected]>
  • Loading branch information
fivetran-catfritz and fivetran-avinash authored Jan 22, 2025
1 parent a2b83e0 commit 3fa1b1c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# dbt_shopify v0.16.0
[PR #97](https://github.com/fivetran/dbt_shopify/pull/97) includes the following updates:
This release includes the following updates:

## Bug Fixes
- Removed incremental logic in the following end models:
- Removed incremental logic in the following end models
([PR #97](https://github.com/fivetran/dbt_shopify/pull/97)):
- `shopify__discounts`
- `shopify__order_lines`
- `shopify__orders`
Expand All @@ -14,6 +15,10 @@
- For each staging model, if the source table is not found in any of your schemas, the package will create a table with one row with null values for Redshift destinations. There will be no change in behavior in non-Redshift warehouses.
- This is necessary as Redshift will ignore explicit data casts when a table is completely empty and materialize every column as a `varchar`. This throws errors in downstream transformations in the `shopify` package. The 1 row will ensure that Redshift will respect the package's datatype casts.

## Documentation
- Added Quickstart model counts to README. ([#96](https://github.com/fivetran/dbt_shopify/pull/96))
- Corrected references to connectors and connections in the README. ([#96](https://github.com/fivetran/dbt_shopify/pull/96))

# dbt_shopify v0.15.0

[PR #94](https://github.com/fivetran/dbt_shopify/pull/94) includes the following updates:
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,16 @@ Curious what these tables can do? Check out example visualizations from the [sho
</a>
</p>

### Materialized Models
Each Quickstart transformation job run materializes 89 models if all components of this data model are enabled. This count includes all staging, intermediate, and final models materialized as `view`, `table`, or `incremental`.
<!--section-end-->

## How do I use the dbt package?

### Step 1: Prerequisites
To use this dbt package, you must have the following:

- At least one Fivetran Shopify connector syncing data into your destination.
- At least one Fivetran Shopify connection syncing data into your destination.
- One of the following destinations:
- [BigQuery](https://fivetran.com/docs/destinations/bigquery)
- [Snowflake](https://fivetran.com/docs/destinations/snowflake)
Expand Down Expand Up @@ -84,7 +86,7 @@ dispatch:
```

### Step 3: Define database and schema variables
#### Single connector
#### Single connection
By default, this package runs using your destination and the `shopify` schema. If this is not where your Shopify data is (for example, if your Shopify schema is named `shopify_fivetran`), add the following configuration to your root `dbt_project.yml` file:

```yml
Expand All @@ -94,8 +96,8 @@ vars:
shopify_database: your_database_name
shopify_schema: your_schema_name
```
#### Union multiple connectors
If you have multiple Shopify 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 `shopify_union_schemas` OR `shopify_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
#### Union multiple connections
If you have multiple Shopify 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 `shopify_union_schemas` OR `shopify_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:

```yml
# dbt_project.yml
Expand All @@ -110,7 +112,7 @@ To connect your multiple schema/database sources to the package models, follow t

### Step 4: Disable models for non-existent sources

The package takes into consideration that not every Shopify connector may have the `fulfillment_event`, `metadata`, or `abandoned_checkout` tables (including `abandoned_checkout`, `abandoned_checkout_discount_code`, and `abandoned_checkout_shipping_line`) and allows you to enable or disable the corresponding functionality. To enable/disable the modeling of the mentioned source tables and their downstream references, add the following variable to your `dbt_project.yml` file:
The package takes into consideration that not every Shopify connection may have the `fulfillment_event`, `metadata`, or `abandoned_checkout` tables (including `abandoned_checkout`, `abandoned_checkout_discount_code`, and `abandoned_checkout_shipping_line`) and allows you to enable or disable the corresponding functionality. To enable/disable the modeling of the mentioned source tables and their downstream references, add the following variable to your `dbt_project.yml` file:

```yml
# dbt_project.yml
Expand Down

0 comments on commit 3fa1b1c

Please sign in to comment.