Recce

recce is an environment diff tool for DBT projects. It helps you to compare the results of two environments, such as development and production, and identify the differences.

Features

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

Use cases

During development, we can verify new results by contrasting them with those from production prior to pushing the changes.
While reviewing PR, you can grasp the extent of the changes and their impact before merging.
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 development and another is for production. You can prepare two targets with separate schemas in your 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

5 minutes walkthrough by jaffle shop example

Installation
```
pip install recce
```
Go to your DBT project
```
cd your-dbt-project/
```
Prepare base artifacts: DBT generates artifacts when every invocation. You can find these files in the target/ folder.

artifacts DBT command

manifest.json dbt run, dbt build, ..

catalog.json (optional) dbt docs generate

Copy the artifacts for the base environment to target-base/ folder.
Run the recce server.
```
recce server
```
Recce would diff environments between target/ and target-base/

artifacts	DBT command
manifest.json	`dbt run`, `dbt build`, ..
catalog.json (optional)	`dbt docs generate`

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 a 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 uses the credentials to connect to both environments. So please make sure that the credential can access both environments.

Metadata

Release files for recce-nightly 0.1.0.20240102

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for recce-nightly 0.1.0.20240102
File	Size	Uploaded
recce-nightly-0.1.0.20240102.tar.gz	578.7 kB	Jan 2, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for recce-nightly 0.1.0.20240102
File	Interpreter	ABI	Platform	Reset
recce_nightly-0.1.0.20240102-py3-none-any.whl 586.4 kB Jan 2, 2024	Python 3	none	any	Details

Total release size: 1.2 MB

Release files / recce-nightly-0.1.0.20240102.tar.gz

Download URL	recce-nightly-0.1.0.20240102.tar.gz
Size	578.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`7753188a23017b5c6bea935165644bf58487ac1866380159c7b3b51a6235753e`
BLAKE2b-256 checksum How to use checksums	`7ec7e3d77a6f341a9e303b4f171cb6200eca2c49af9ae80d74d20e407769ad11`
Upload date	Jan 2, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.13`

Release files / recce_nightly-0.1.0.20240102-py3-none-any.whl

Download URL	recce_nightly-0.1.0.20240102-py3-none-any.whl
Size	586.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ed97a67efc0a684cb2cfba18bda4f4d1bfeb8a2e1845784da703d1b0a1f358e6`
BLAKE2b-256 checksum How to use checksums	`d427a4abf9ec3757277952d7e541dfd481872a6de745727be9478da6cfe9ee2e`
Upload date	Jan 2, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.10.13`