You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/3-visualized-change/multi-models.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,9 @@ To select multiple models individually, click the checkbox on the models you wis
20
20
21
21
To select a node and all of its parents or children:
22
22
23
-
1. Click the checkbox on the node.
24
-
2. Right-click the node.
25
-
3. Click to select either parent or child models.
23
+
1. Click the checkbox on the node
24
+
2. Right-click the node
25
+
3. Click to select either parent or child models
26
26
27
27
<figuremarkdown>
28
28
{: .shadow}
@@ -88,7 +88,7 @@ Since Recce uses dbt's built-in node selector, it supports most of the selecting
88
88
89
89
### Use `state` method
90
90
91
-
In dbt, you need to specify the `--state` option in the CLI. In Recce, we use the base environment as the state, allowing you to use the selector on the fly.
91
+
In dbt, you need to specify the `--state` option in the CLI. In Recce we use the base environment as the state, allowing you to use the selector on the fly.
92
92
93
93
94
94
### Removed models
@@ -97,7 +97,7 @@ Another difference is that in dbt, you cannot select removed models. However, in
97
97
98
98
## Supported Diff
99
99
100
-
In addition to lineage diff, other types of diff also support node selection. You can find these features in the **...** button in the top right corner. Currently supported diffs include:
100
+
In addition to lineage diff, other types of diff also support node selection. You can find these features in the **...** button in the top right corner. Currently supported node-based diffs include:
Copy file name to clipboardExpand all lines: docs/5-data-diffing/query.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,11 +53,11 @@ In the current version, Recce provides two ways to compare the query result betw
53
53
54
54
**Query diff occurs in the client side:**
55
55
56
-
Without providing primary key(s) upfront, AdHoc query compare in the client side. That is, Recce fetches the first 2,000 rows and compare in the client side. The advantage is it has more flexibility to query sql for no PK, especially when column structures differ or no clear primary key exists.
56
+
Without primary keys provided upfront, adhoc queries will compare results on the client side. That is, Recce fetches the first 2,000 rows and compare in the client side. The advantage is it has more flexibility to query sql for no PK, especially when column structures differ or no clear primary key exists.
57
57
However, the limitation is that we cannot find the mismatched rows in a big query result.
58
58
59
59
**Query diff occurs in the warehouse:**
60
60
61
-
With primary key(s) given, it can perform a query diff in the warehouse. It only displays changed, added, or removed rows. Therefore, if only one record is different among a million, that specific record will be visible. Hence, it also reduces the amount of data transferred.
61
+
When primary keys are given, it can perform a query diff in the warehouse. It will only display changed, added, or removed rows. Meaning, if only one record is different among a million, that specific record will be visible. Thus reducing the amount of data transferred.
62
62
63
63
Another similar feature is [Value Diff](lineage.md#value-diff). Value diff is based on a chosen model, so you don’t need to write SQL to operate it, though it naturally offers less flexibility. Additionally, value diff can show a summary or actual diff records, whereas query diff only shows the actual diff records.
Copy file name to clipboardExpand all lines: docs/5-data-diffing/value-diff.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: Value Diff
5
5
6
6
Value Diff shows the matched count and percentage for each column in the table. It uses the primary key(s) to uniquely identify the records between the model in both environments.
7
7
8
-
The primary key is automatically inferred by the first column with the [unique](https://docs.getdbt.com/reference/resource-properties/data-tests#unique) test. If no primary key is detected at least one column is required to be specified as the primary key.
8
+
The primary key (PK) is automatically inferred by the first column with the [unique](https://docs.getdbt.com/reference/resource-properties/data-tests#unique) test. If no primary key is detected at least one column is required to be specified as the primary key.
9
9
10
10
<figuremarkdown>
11
11

Copy file name to clipboardExpand all lines: docs/6-collaboration/checklist.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,9 +34,9 @@ An example performing a Top-K diff and adding the results to the Checklist:
34
34
35
35
The Recce Checklist provides a way to record the results of a data check during change exploration. The purpose of adding Checks to the Checklist is to enable you to:
36
36
37
-
- Save Checks with notes of your interpretation of the data.
38
-
- Re-run checks following further data modeling changes.
39
-
- Share Checks as part of PR or stakeholder review.
37
+
- Save Checks with notes of your interpretation of the data
38
+
- Re-run checks following further data modeling changes
39
+
- Share Checks as part of PR or stakeholder review
Copy file name to clipboardExpand all lines: docs/7-cicd/best-practices-prep-env.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ Recce is designed to compare two environments in your data project. To use it ef
6
6
7
7
However, there are many challenges in preparing environments.
8
8
9
-
1. Your **source data** might be continuously updating.
10
-
2. Your transformations might be **time-consuming**.
11
-
3. The base branch may have **other PRs merged** at any time.
12
-
4. The generated environment will leave data in the warehouse, which also needs to be properly managed.
9
+
1. Your **source data** might be continuously updating
10
+
2. Your transformations might be **time-consuming**
11
+
3. The base branch may have **other PRs merged** at any time
12
+
4. The generated environment will leave data in the warehouse, which also needs to be properly managed
13
13
14
-
This article will not focus on how to use Recce but rather on how to effectively prepare environments for Recce use.
14
+
This article will not focus on how to use Recce, but rather on how to effectively prepare environments for Recce use.
15
15
16
16
17
17
## Best Practices
@@ -88,9 +88,9 @@ Using the production environment as the base environment is a straightforward ch
88
88
89
89
This staging environment can have the following characteristics:
90
90
91
-
1. Ensure that the transformed results reflect the **latest commit** of the base branch.
92
-
2. Use the **same source data** as the PR environment.
93
-
3. Use the **same transformation logic** as the PR environment.
91
+
1. Ensure that the transformed results reflect the **latest commit** of the base branch
92
+
2. Use the **same source data** as the PR environment
93
+
3. Use the **same transformation logic** as the PR environment
94
94
95
95
The basic principle is that the staging environment's configuration should be **as close as possible to the PR environments**, except for using a different git commit.
96
96
@@ -168,9 +168,9 @@ Recce relies on the base and current environment artifacts to find the correspon
168
168
169
169
Here are a few methods you can choose:
170
170
171
-
1. In CI, upload the generated artifact to the cloud storage (e.g., AWS S3).
172
-
2. For dbt Cloud users, you can [download artifacts](https://docs.getdbt.com/dbt-cloud/api-v2#/operations/Retrieve%20Run%20Artifact) for the latest run of a given job.
173
-
3. For GitHub Actions users, you can use the GitHub CLI (gh) to [download artifacts](https://cli.github.com/manual/gh_run_download) for the latest run of a given workflow.
171
+
1. In CI, upload the generated artifact to the cloud storage (e.g., AWS S3)
172
+
2. For dbt Cloud users, you can [download artifacts](https://docs.getdbt.com/dbt-cloud/api-v2#/operations/Retrieve%20Run%20Artifact) for the latest run of a given job
173
+
3. For GitHub Actions users, you can use the GitHub CLI (gh) to [download artifacts](https://cli.github.com/manual/gh_run_download) for the latest run of a given workflow
174
174
175
175
If the methods mentioned above are too complex, a stateless approach is to directly check out the base branch and run **`dbt docs generate`** to generate the artifacts.
Copy file name to clipboardExpand all lines: docs/7-cicd/index.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ icon: material/hand-wave-outline
4
4
---
5
5
6
6
## What is Recce Cloud?
7
-
Recce Cloud is a data collaboration platform for teams doing data validation, impact analysis, and pull requests reviews. It helps data teams catch issues early, understand downstream impacts, and communicate changes clearly—all in one shared workspace. Instead of working alone in a local dev environment, teams can explore lineage, run custom queries, and validate metrics together, speeding up reviews and building trust across stakeholders.
7
+
Recce Cloud is a data collaboration platform for teams doing data validation, impact analysis, and pull requests reviews. It helps data teams catch issues early, understand downstream impacts, and communicate changes clearly in one shared workspace. Instead of working in an isolated local environment, teams can explore lineage, run custom queries, and validate metrics together in a cloud-hosted environment.
8
8
9
9
-[Learn more about different plans](https://reccehq.com/pricing)
10
10
- Follow the [Getting Started](/get-started/) guide
@@ -14,9 +14,9 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
14
14
15
15
### Prerequisite
16
16
1. Sign in [Recce cloud](https://cloud.reccehq.com/)
17
-
2. Click **Install** button to install Recce Cloud GitHub app to your personal or organization account.
18
-
3. Authorize the repositories to the GitHub app.
19
-
4. Prepare the GitHub personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable.
17
+
2. Click **Install** button to install Recce Cloud GitHub app to your personal or organization account
18
+
3. Authorize the repositories to the GitHub app
19
+
4. Prepare the GitHub personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable
20
20
```
21
21
export GITHUB_TOKEN=<token>
22
22
```
@@ -36,8 +36,8 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
36
36
git checkout -b <my-awesome-feature>
37
37
```
38
38
1. Develop your features and prepare the dbt artifacts for the base (`target-base/`) and current (`target/`) environments.
39
-
1. Create a pull request for this branch. Recce Cloud requires an open pull request in your GitHub repository. It also stores the latest Recce state for each pull request.
40
-
1. Launch the Recce instance in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
39
+
2. Create a pull request for this branch. Recce Cloud requires an open pull request in your GitHub repository. It also stores the latest Recce state for each pull request.
40
+
3. Launch the Recce instance in the cloud mode. It will use the dbt artifacts in the local `target` and `target-base` and initiate a new review state if necessary.
41
41
```
42
42
recce server --cloud
43
43
```
@@ -51,7 +51,7 @@ Recce Cloud integrates with GitHub to support validation in your PR workflow. Th
51
51
If the review state is already available for this PR, you can open the Recce instance to review.
The cloud subcommand in recce provides functionality for managing state files in cloud storage.
108
+
The cloud subcommand in Recce provides functionality for managing state files in cloud storage.
109
109
110
110
#### purge
111
111
112
112
You can purge the state from your current PR. It is useful when
113
113
114
114
1. You forgot the password
115
-
1. You would like to reset the state of this PR.
115
+
1. You would like to reset the state of this PR
116
116
117
117
```shell
118
118
git checkout <pr-branch>
@@ -139,6 +139,6 @@ recce cloud download
139
139
140
140
## GitHub Pull Request Status Check
141
141
142
-
Recce Cloud integrate with the [GitHub Pull Request Status Check](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). If there is recce review state synced to a PR, the PR would have a recce cloud check status. Once all checks in recce are approved, the check status would change to passed and ready to be merged.
142
+
Recce Cloud integrate with the [GitHub Pull Request Status Check](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks). If there is Recce review state synced to a PR, the PR would have a Recce cloud check status. Once all checks in Recce are approved, the check status would change to passed and ready to be merged.
Copy file name to clipboardExpand all lines: docs/7-cicd/recce-summary.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Summary
3
3
---
4
4
5
-
Recce `Summary` command is used to generate a summary based on the input state file. In the previous section, the `Run` command was used to generate a state file based on the two environments. It provides a way to integrate Recce into your CI/CD pipeline. The `Summary` command is used to generate a summary based on the output of `Run` command. You can also integrate the `Summary` command into your CI/CD pipeline to generate a summary based on the state file generated by the `Run` command. Therefor, the generated summary can be posted to your repository hosting platform, such as GitHub, GitLab, or Bitbucket.
5
+
Recce `Summary` command is used to generate a summary based on the input state file. In the previous section, the `Run` command was used to generate a state file based on the two environments. It provides a way to integrate Recce into your CI/CD pipeline. The `Summary` command is used to generate a summary based on the output of `Run` command. You can also integrate the `Summary` command into your CI/CD pipeline to generate a summary based on the state file generated by the `Run` command. Thus allowing the generated summary can be posted to your repository hosting platform, such as GitHub, GitLab, or Bitbucket.
6
6
7
7
## Usage
8
8
@@ -18,7 +18,7 @@ recce summary recce-state.json
18
18
19
19
## Output
20
20
21
-
The output of the `summary` command will be Markdown format. The markdown output will contain the following sections:
21
+
The output of the `summary` command will be in markdown format. The markdown output will contain the following sections:
22
22
23
23
- Lineage Graph - A graph that shows the lineage of the models that are impacted by the modified models.
24
24
- Checks Summary - A summary of the checks that are detected mismatch between `base` and `current` environments.
0 commit comments