You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,26 @@
1
+
# dbt_apple_store v1.0.0
2
+
[PR #41](https://github.com/fivetran/dbt_apple_store/pull/41) includes the following updates:
3
+
4
+
## Breaking Changes
5
+
6
+
### Source Package Consolidation
7
+
- Removed the dependency on the `fivetran/apple_store_source` package.
8
+
- All functionality from the source package has been merged into this transformation package for improved maintainability and clarity.
9
+
- If you reference `fivetran/apple_store_source` in your `packages.yml`, you must remove this dependency to avoid conflicts.
10
+
- Any source overrides referencing the `fivetran/apple_store_source` package will also need to be removed or updated to reference this package.
11
+
- Update any apple_store_source-scoped variables to be scoped to only under this package. See the [README](https://github.com/fivetran/dbt_apple_store/blob/main/README.md) for how to configure the build schema of staging models.
12
+
- As part of the consolidation, vars are no longer used to reference staging models, and only sources are represented by vars. Staging models are now referenced directly with `ref()` in downstream models.
13
+
14
+
### dbt Fusion Compatibility Updates
15
+
- 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`).
16
+
- 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.
17
+
- Removed all `dbt_utils.unique_combination_of_columns` tests.
18
+
- Moved `loaded_at_field: _fivetran_synced` under the `config:` block in `src_apple_store.yml`.
19
+
20
+
### Under the Hood
21
+
- Updated conditions in `.github/workflows/auto-release.yml`.
22
+
- Added `.github/workflows/generate-docs.yml`.
23
+
1
24
# dbt_apple_store v0.6.0
2
25
[PR #36](https://github.com/fivetran/dbt_apple_store/pull/36) includes the following updates:
- Produces modeled tables that leverage Apple App Store data from [Fivetran's connector](https://fivetran.com/docs/connectors/applications/apple-app-store) in the format described by [this ERD](https://fivetran.com/docs/connectors/applications/apple-app-store#salesandfinancereportschema) and build off the output of our [Apple App Store source package](https://github.com/fivetran/dbt_apple_store_source).
19
+
- Produces modeled tables that leverage Apple App Store data from [Fivetran's connector](https://fivetran.com/docs/connectors/applications/apple-app-store) in the format described by [this ERD](https://fivetran.com/docs/connectors/applications/apple-app-store#salesandfinancereportschema).
20
20
- Enables you to better understand your Apple App Store metrics at different granularities. It achieves this by:
21
21
- Providing intuitive reporting at the App Version, Platform Version, Device, Source Type, Territory, Subscription and Overview levels
22
22
- Aggregates all relevant application metrics into each of the reporting levels above
@@ -55,11 +55,10 @@ Include the following apple_store package version in your `packages.yml` file:
55
55
```yaml
56
56
packages:
57
57
- package: fivetran/apple_store
58
-
version: [">=0.6.0", "<0.7.0"]
58
+
version: [">=1.0.0", "<1.1.0"]
59
59
```
60
60
61
-
Do NOT include the `apple_store_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
62
-
61
+
> All required sources and staging models are now bundled into this transformation package. Do not include `fivetran/apple_store_source` in your `packages.yml` since this package has been deprecated.
63
62
64
63
### Step 3: Define database and schema variables
65
64
By default, this package runs using your destination and the `apple_store` schema. If this is not where your apple_store data is (for example, if your apple_store schema is named `apple_store_fivetran`), add the following configuration to your root `dbt_project.yml` file:
@@ -82,7 +81,7 @@ vars:
82
81
83
82
In order to map longform territory names to their ISO country codes, we have adapted the CSV from [lukes/ISO-3166-Countries-with-Regional-Codes](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes) to align with Apple's country output [format](https://developer.apple.com/help/app-store-connect/reference/app-store-localizations/).
84
83
85
-
You will need to `dbt seed` the `apple_store_country_codes` [file](https://github.com/fivetran/dbt_apple_store_source/blob/main/seeds/apple_store_country_codes.csv) just once.
84
+
You will need to `dbt seed` the `apple_store_country_codes` [file](https://github.com/fivetran/dbt_apple_store/blob/main/seeds/apple_store_country_codes.csv) just once.
@@ -112,20 +111,20 @@ By default, `Subscribe`, `Renew` and `Cancel` subscription events are included a
112
111
```
113
112
114
113
#### Change the build schema
115
-
By default, this package builds the apple_store staging models within a schema titled (`<target_schema>` + `_stg_apple_store`) and your apple_store modeling models within a schema titled (`<target_schema>` + `_apple_store`) in your destination. If this is not where you would like your apple_store data to be written to, add the following configuration to your root `dbt_project.yml` file:
114
+
By default, this package builds the apple_store staging models within a schema titled (`<target_schema>` + `apple_store_source`) and your apple_store modeling models within a schema titled (`<target_schema>` + `_apple_store`) in your destination. If this is not where you would like your apple_store data to be written to, add the following configuration to your root `dbt_project.yml` file:
116
115
117
116
```yml
118
117
models:
119
-
apple_store_source:
120
-
+schema: my_new_schema_name # leave blank for just the target_schema
121
118
apple_store:
122
-
+schema: my_new_schema_name # leave blank for just the target_schema
119
+
+schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
120
+
staging:
121
+
+schema: my_new_schema_name # Leave +schema: blank to use the default target_schema.
123
122
```
124
-
123
+
125
124
#### Change the source table references
126
125
If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
127
126
128
-
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_apple_store_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
127
+
> IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_apple_store/blob/main/dbt_project.yml) variable declarations to see the expected names.
129
128
130
129
```yml
131
130
vars:
@@ -136,24 +135,24 @@ vars:
136
135
### (Optional) Step 7: Orchestrate your models with Fivetran Transformations for dbt Core™
137
136
<details><summary>Expand for details</summary>
138
137
<br>
139
-
138
+
140
139
Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).
141
140
</details>
142
141
143
142
## Does this package have dependencies?
144
143
This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site.
145
144
> IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts.
146
-
145
+
147
146
```yml
148
147
packages:
149
-
- package: fivetran/apple_store_source
150
-
version: [">=0.6.0", "<0.7.0"]
151
-
152
148
- package: fivetran/fivetran_utils
153
149
version: [">=0.4.0", "<0.5.0"]
154
150
155
151
- package: dbt-labs/dbt_utils
156
152
version: [">=1.0.0", "<2.0.0"]
153
+
154
+
- package: dbt-labs/spark_utils
155
+
version: [">=0.3.0", "<0.4.0"]
157
156
```
158
157
## How is this package maintained and can I contribute?
0 commit comments