diff --git a/CHANGELOG.md b/CHANGELOG.md index 17d1932..463742d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,8 @@ ## Documentation - Updated README formatting for consistency with other packages. +- Added Quickstart model counts to README. ([#52](https://github.com/fivetran/dbt_xero/pull/52)) +- Corrected references to connectors and connections in the README. ([#52](https://github.com/fivetran/dbt_xero/pull/52)) ## Under the Hood (maintainers only) - Added consistency tests for the end models. diff --git a/README.md b/README.md index 35f02b4..0d706eb 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ The following table provides a detailed list of all tables materialized within t | [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. | | [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. | +### Materialized Models +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`. ## How do I use the dbt package? @@ -39,7 +41,7 @@ The following table provides a detailed list of all tables materialized within t ### Step 1: Prerequisites To use this dbt package, you must have the following: -- At least one Fivetran Xero connector syncing data into your destination. +- At least one Fivetran Xero connection syncing data into your destination. - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. ### Step 2: Install the package @@ -67,8 +69,8 @@ vars: 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. -#### Unioning Multiple Xero Connectors -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: +#### Unioning Multiple Xero Connections +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: ```yml # dbt_project.yml