Skip to content

Commit

Permalink
Feature: Add Quickstart Model Counts to README (#29)
Browse files Browse the repository at this point in the history
* MagicBot/add-model-counts updates

* Update README.md
  • Loading branch information
fivetran-catfritz authored Jan 21, 2025
1 parent 96f8dd2 commit 1279f74
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# dbt_pendo version.version

## Documentation
- Added Quickstart model counts to README. ([#29](https://github.com/fivetran/dbt_pendo/pull/29))
- Corrected references to connectors and connections in the README. ([#29](https://github.com/fivetran/dbt_pendo/pull/29))

# dbt_pendo v0.UPDATE.UPDATE

## Under the Hood:
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
<p align="center">
# Pendo Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_pendo/))

<p align="left">
<a alt="License"
href="https://github.com/fivetran/dbt_pendo/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
Expand All @@ -10,7 +12,6 @@
<img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
</p>

# Pendo Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_pendo/))
## What does this dbt package do?
- Produces modeled tables that pendoage Pendo data from [Fivetran's connector](https://fivetran.com/docs/applications/pendo) in the format described by [this ERD](https://fivetran.com/docs/applications/pendo#schemainformation) and builds off the output of our [Pendo source package](https://github.com/fivetran/dbt_pendo_source).

Expand Down Expand Up @@ -43,12 +44,14 @@ The following table provides a detailed list of all tables materialized within t
| [pendo__guide_event](https://fivetran.github.io/dbt_pendo/#!/model/model.pendo.pendo__guide_daily_metrics) | The event stream of different kinds of interactions visitors have with guides. Enriched with any visitor and/or account passthrough columns, as well as the application and platform that the event occurred on. |
| [pendo__visitor_feature](https://fivetran.github.io/dbt_pendo/#!/model/model.pendo.pendo__visitor_feature) | Each record represents a unique combination of visitors and features, aimed at making "power-users" of particular features easy to find. Includes metrics reflecting the longevity and frequency of feature usage. |

### Materialized Models
Each Quickstart transformation job run materializes 68 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`.
<!--section-end-->

## How do I use the dbt package?
### Step 1: Prerequisites
To use this dbt package, you must have the following:
- At least one Fivetran Pendo connector syncing data into your destination.
- At least one Fivetran Pendo connection syncing data into your destination.
- A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination.

#### Databricks Dispatch Configuration
Expand Down

0 comments on commit 1279f74

Please sign in to comment.