Skip to content

Commit b488982

Browse files
Merge pull request #52 from fivetran/MagicBot/add-model-counts
Feature: Add Quickstart Model Counts to README
2 parents e705311 + 7fb52a0 commit b488982

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
## Documentation
1212
- Updated README formatting for consistency with other packages.
13+
- Added Quickstart model counts to README. ([#52](https://github.com/fivetran/dbt_xero/pull/52))
14+
- Corrected references to connectors and connections in the README. ([#52](https://github.com/fivetran/dbt_xero/pull/52))
1315

1416
## Under the Hood (maintainers only)
1517
- Added consistency tests for the end models.

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,16 @@ The following table provides a detailed list of all tables materialized within t
3232
| [xero__balance_sheet_report](https://github.com/fivetran/dbt_xero/blob/main/models/xero__balance_sheet_report.sql) | Each record represents the state of the balance sheet for a given account on a given month. |
3333
| [xero__invoice_line_items](https://github.com/fivetran/dbt_xero/blob/main/models/xero__invoice_line_items.sql) | Each record represents an invoice line item enriched with the account, contact, and invoice information. |
3434

35+
### Materialized Models
36+
Each Quickstart transformation job run materializes 22 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`.
3537
<!--section-end-->
3638

3739
## How do I use the dbt package?
3840

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

42-
- At least one Fivetran Xero connector syncing data into your destination.
44+
- At least one Fivetran Xero connection syncing data into your destination.
4345
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.
4446

4547
### Step 2: Install the package
@@ -67,8 +69,8 @@ vars:
6769

6870
If you are using multi-currency accounting in Xero, you are likely to have unrealized currency gains as part of your profit and loss statement. These gains/losses do not exist within the actual journals in Xero. As a result, you will find that those lines are missing from the outputs of this package. All realised currency gains will be present and your balance sheet will still balance.
6971

70-
#### Unioning Multiple Xero Connectors
71-
If you have multiple Xero 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** (**note that you cannot use both**) the `union_schemas` or `union_databases` variables:
72+
#### Unioning Multiple Xero Connections
73+
If you have multiple Xero 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** (**note that you cannot use both**) the `union_schemas` or `union_databases` variables:
7274

7375
```yml
7476
# dbt_project.yml

0 commit comments

Comments
 (0)