Metadata-Version: 2.1
Name: recce
Version: 0.1.0.dev1
Summary: Environment diff tool for dbt
Home-page: https://github.com/InfuseAI/recce
Author: InfuseAI Dev Team
Author-email: dev@infuseai.io
Project-URL: Bug Tracker, https://github.com/InfuseAI/recce/issues
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ruamel.yaml <0.18.0
Requires-Dist: click >=7.1
Requires-Dist: dbt-core >=1.3
Requires-Dist: pandas
Requires-Dist: portalocker
Requires-Dist: fastapi
Requires-Dist: itsdangerous
Requires-Dist: uvicorn
Requires-Dist: pydantic
Requires-Dist: jinja2
Requires-Dist: requests >=2.28.1
Requires-Dist: rich >=12.0.0
Requires-Dist: sentry-sdk
Provides-Extra: dev
Requires-Dist: pytest >=4.6 ; extra == 'dev'
Requires-Dist: pytest-flake8 ; extra == 'dev'
Requires-Dist: flake8 ==3.9.2 ; extra == 'dev'
Requires-Dist: pytest-mypy ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'

# recce

`recce` is a environment diff tool for dbt

## Features

1. Support both Web UI & CLI
1. Multiple diff tools, including lineage diff, schema diff, and query diff. And more in the future.
1. 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](https://docs.getdbt.com/docs/core/dbt-core-environments) in your dbt project. For example, one is for developing and another is for production. You can prepare two targets with separate [schemas](https://docs.getdbt.com/docs/core/connect-data-platform/connection-profiles#understanding-target-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
   ```

1. Recce use [dbt artifacts](https://docs.getdbt.com/reference/artifacts/dbt-artifacts) to interact with your dbt project. You need to prepare the artifacts for the base environment.

   ```shell
   # 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/
   ```

1. Develop your awesome features

   ```shell
   # transform the data to data warehouse
   dbt run

   # generate the catalog.json
   dbt docs generate
   ```

1. Run the recce server

   ```
   recce server
   ```

   and open the url link

1. Check the lineage diff to see the modified node. Click one node to see the schema difference.
1. Switch to **query** tab, Write and run a query diff. It would query on the both side and diff the query results.

   ```jinja
   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

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

- **CLI**:

  ```shell
  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.

  ```shell
  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](https://docs.getdbt.com/docs/connect-adapters) 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.
