From 61a0e8c32e2f71f39b77d1c0885fc3bc3ce50794 Mon Sep 17 00:00:00 2001 From: fivetran-catfritz <111930712+fivetran-catfritz@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:02:11 -0600 Subject: [PATCH] Feature: Add Quickstart Model Counts to README (#156) * MagicBot/add-model-counts updates * Update README.md * Update README.md --- CHANGELOG.md | 6 ++++++ README.md | 8 +++++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 43cc891..d5d5e8a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# dbt_netsuite version.version + +## Documentation +- Added Quickstart model counts to README. ([#156](https://github.com/fivetran/dbt_netsuite/pull/156)) +- Corrected references to connectors and connections in the README. ([#156](https://github.com/fivetran/dbt_netsuite/pull/156)) + # dbt_netsuite v0.17.1 [PR #155](https://github.com/fivetran/dbt_netsuite/pull/155) includes the following updates: diff --git a/README.md b/README.md index 59adb72..3e8768a 100644 --- a/README.md +++ b/README.md @@ -33,12 +33,14 @@ The following table provides a detailed list of all tables materialized within t | [netsuite__balance_sheet](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite__balance_sheet) or [netsuite2__balance_sheet](https://fivetran.github.io/dbt_netsuite/#!/model/model.netsuite.netsuite2__balance_sheet) | All transaction lines necessary to generate a balance sheet (converted for the appropriate exchange rate of the parent subsidiary). Non balance sheet transactions are categorized as either Retained Earnings or Net Income. | Many of the above reports are now configurable for [visualization via Streamlit](https://github.com/fivetran/streamlit_netsuite)! Check out some [sample reports here](https://fivetran-netsuite.streamlit.app/). +### Materialized Models +Each Quickstart transformation job run materializes 88 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? ### Step 1: Prerequisites -To use this dbt package, you must have At least either one Fivetran **Netsuite** (netsuite.com) or **Netsuite2** (netsuite2) connector syncing the respective tables to your destination: +To use this dbt package, you must have At least either one Fivetran **Netsuite** (netsuite.com) or **Netsuite2** (netsuite2) connection syncing the respective tables to your destination: #### Netsuite.com - accounts - accounting_periods @@ -106,7 +108,7 @@ packages: ``` ### Step 3: Define Netsuite.com or Netsuite2 Source -As of April 2022 Fivetran made available a new Netsuite connector which leverages the Netsuite2 endpoint opposed to the original Netsuite.com endpoint. This package is designed to run for either or, not both. By default the `netsuite_data_model` variable for this package is set to the original `netsuite` value which runs the netsuite.com version of the package. If you would like to run the package on Netsuite2 data, you may adjust the `netsuite_data_model` variable to run the `netsuite2` version of the package. +As of April 2022 Fivetran released a new Netsuite connector version which leverages the Netsuite2 endpoint opposed to the original Netsuite.com endpoint. This package is designed to run for either or, not both. By default the `netsuite_data_model` variable for this package is set to the original `netsuite` value which runs the netsuite.com version of the package. If you would like to run the package on Netsuite2 data, you may adjust the `netsuite_data_model` variable to run the `netsuite2` version of the package. ```yml vars: netsuite_data_model: netsuite2 #netsuite by default @@ -122,7 +124,7 @@ vars: ``` ### Step 5: Disable models for non-existent sources (Netsuite2 only) -It's possible that your Netsuite connector does not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that feature in Netsuite or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, all variables are assumed to be true. Add variables for only the tables you would like to disable: +Your Netsuite connection may not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that feature in Netsuite or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, all variables are assumed to be true. Add variables for only the tables you would like to disable: ```yml vars: netsuite2__multibook_accounting_enabled: true # False by default. Disable `accountingbooksubsidiary` and `accountingbook` if you are not using the Multi-Book Accounting feature