diff --git a/CHANGELOG.md b/CHANGELOG.md index 77c7883..d5d1072 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +# dbt_twitter_organic version.version + +## Documentation +- Added Quickstart model counts to README. ([#15](https://github.com/fivetran/dbt_twitter_organic/pull/15)) +- Corrected references to connectors and connections in the README. ([#15](https://github.com/fivetran/dbt_twitter_organic/pull/15)) + # dbt_twitter_organic v0.3.0 ## Upstream Breaking Changes diff --git a/README.md b/README.md index dc67f7d..e555b67 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,15 @@ You can also refer to the table below for a detailed view of all tables material | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [twitter_organic__tweets](https://github.com/fivetran/dbt_twitter_organic/blob/main/models/twitter_organic__tweets.sql) | Each record represents the daily performance of a tweet. | +### Materialized Models +Each Quickstart transformation job run materializes 11 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: Pre-Requisites -You will need to ensure you have the following before leveraging the dbt package. -- **Connector**: Have the Fivetran Twitter Organic connector syncing data into your warehouse. -- **Database support**: This package has been tested on **BigQuery**, **Snowflake**, **Redshift**, **Databricks**, and **Postgres**. Ensure you are using one of these supported databases. +To use this dbt package, you must have the following: +- At least one Fivetran Twitter Organic connection syncing data into your destination. +- A BigQuery, Snowflake, Redshift, PostgreSQL, or Databricks destination. #### Databricks Additional Configuration If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your root `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively. @@ -91,8 +93,8 @@ vars: twitter__identifier: your_table_name ``` -#### Unioning Multiple Twitter Organic Connectors -If you have multiple Twitter Organic 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(s) into the final models. You will be able to see which source it came from in the `source_relation` column(s) 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 Twitter Organic Connections +If you have multiple Twitter Organic 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(s) into the final models. You will be able to see which source it came from in the `source_relation` column(s) 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