recce-nightly 0.1.0.20231128

Environment diff tool for dbt

recce

recce is a environment diff tool for dbt

Features

1. Support both Web UI & CLI
2. Multiple diff tools, including lineage diff, schema diff, and query diff. And more in the future.
3. Use the dbt-core adapter framework to connect to your data warehouse. No additional configuration required.

Use cases

1. During development, we can verify new results by contrasting them with those from production prior to pushing the changes.
2. While reviewing PR, you can grasp the extent of the changes and their impact before merge.
3. For troubleshooting, you can execute ad-hoc diff queries to pinpoint the root causes.

Usage

Prerequisites

You have to have at least two environments in your dbt project. For example, one is for developing and another is for production. You can prepare two targets with separate schemas in you dbt profile. Here is profiles.yml example

jaffle_shop:
  target: dev
  outputs:
    dev:
      type: duckdb
      path: jaffle_shop.duckdb
      schema: dev
    prod:
      type: duckdb
      path: jaffle_shop.duckdb
      schema: main

Getting Started

1. Installation

   pip install recce
   

2. Recce use dbt artifacts to interact with your dbt project. You need to prepare the artifacts for the base environment.

   # transform the data to data warehouse
   dbt run --target prod
   
   # generate the catalog.json
   dbt docs generate --target prod
   

   The artifacts are generated within the target/ directory. Copy these artifacts into the target-base/ directory as the base state to diff.

   mkdir -p target-base/
   cp -R target/ target-base/
   

3. Develop your awesome features

   # transform the data to data warehouse
   dbt run
   
   # generate the catalog.json
   dbt docs generate
   

4. Run the recce server

   recce server
   

   and open the url link

5. Check the lineage diff to see the modified node. Click one node to see the schema difference.

6. Switch to query tab, Write and run a query diff. It would query on the both side and diff the query results.

   select * from {{ ref("mymodel") }}
   

   where ref is a Jinja function to reference a model name.

Query Diff

You can run query diff in both Web UI and CLI

• Web UI: Go to Query tab

  select * from {{ ref("mymodel") }}
  

• CLI:

  recce diff --sql 'select * from {{ ref("mymodel") }}'
  

Primay key

In the query diff, primary key columns serve as the fundamental identifiers for distinguishing each record uniquely across both sides.

• Web UI: In the query result, click the key icons in the column headers to toggle if it is in the primary key list.

• CLI: Use the option --primary-keys to specify the primary keys. Use comma to separate the columns if it is a compound key.

  recce diff --primary-keys event_id --sql 'select * from {{ ref("events") }} order by 1'
  

Q&A

Q: How recce connect to my data warehouse? Does recce support my data warehouse?

recce use the dbt adapter to connect to your warehouse. So it should work for your data warehouse.

Q: What credential does recce connect to the two environments?

Recce uses the same target in the profile to connect your warehouse. If you use the default target dev, it use the credentials to connect to both environments. So please make sure that the credential able to access both environments.