Skip to content

Commit 0641aee

Browse files
authored
Merge pull request #41 from DataRecce/feature/drc-1833-add-warehouse-connection-document-in-the-doc-site
Add the "connect to warehouse" doc
2 parents 46cffc4 + d57a3b8 commit 0641aee

File tree

4 files changed

+49
-2
lines changed

4 files changed

+49
-2
lines changed

docs/2-getting-started/start-free-with-cloud.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,19 @@ Go beyond metadata to see how changes affect your actual data. Configure your da
8686
### Supported Warehouses
8787

8888
- Snowflake
89-
- others are on upcoming future
89+
- Databricks
90+
- Others coming in future releases
9091

9192
### Warehouse Connection
9293

93-
Configure connection to your data warehouse to enable query result comparisons.
94+
Configure connection to your data warehouse to enable query result comparisons. For detailed connection settings, see [Connect to Warehouse](../5-data-diffing/connect-to-warehouse.md).
9495

9596
**Connection setup:**
9697

9798
1. Navigate to [settings](https://cloud.reccehq.com/settings#organization){target="_blank"}
9899
2. Add Connection
100+
3. Navigate to your [project home](https://cloud.datarecce.io/) and open the project settings by clicking the gear icon
101+
4. Link the newly added connection to your project
99102

100103
Your connection credentials are secure. See our [security practices](https://reccehq.com/security/){target="_blank"} for details.
101104

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Connect to Warehouse
3+
---
4+
5+
## Recce OSS
6+
Recce OSS supports all warehouses that dbt supports. It uses the same configuration as dbt, simply use your existing dbt profiles to connect to your warehouse. No additional setup required.
7+
8+
## Recce Cloud
9+
If you use Recce Cloud, here are the warehouse connection settings. We currently support:
10+
11+
- [Snowflake](#snowflake)
12+
- [Databricks](#databricks)
13+
14+
Others are coming in future releases
15+
16+
### Snowflake
17+
We only support password-based authentication.
18+
19+
Field | Description | Examples
20+
----|------|----
21+
`account` | The Snowflake account to connect to | `xxxxxx.us-central1.gcp`
22+
`database` | The default database to connect to | `MYDB`
23+
`schema` | The default schema to connect to | `PUBLIC`
24+
`warehouse` | The warehouse to use when running queries | `WH_LOAD`
25+
`user` | The user to log in as | `MYUSER`
26+
`password` | The password for the user | `MYPASS`
27+
28+
29+
### Databricks
30+
31+
We only support token-based authentication.
32+
33+
Field | Description | Examples
34+
----|------|----
35+
`host` | The hostname of your cluster | `YOURORG.databrickshost.com`
36+
`http_path` | The HTTP path to your SQL Warehouse or all-purpose cluster | `/SQL/YOUR/HTTP/PATH`
37+
`catalog` | The catalog used to connect to the warehouse. This is optional if you are using Unity Catalog | `MY_CATALOG`
38+
`schema` | The default schema to connect to | `MY_SCHEMA`
39+
`token` | The Personal Access Token (PAT) to connect to Databricks | `dapiXXXXXXXXXXXXXXXXXXXXXXX`

docs/styles/extra.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@
3939
font-weight: bold;
4040
} */
4141

42+
.md-nav__item--section>.md-nav__link {
43+
color: #000 !important;
44+
}
45+
4246
.md-nav__link[href]:hover {
4347
color: #ff6e42;
4448
}

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ nav:
6363
- 4-downstream-impacts/breaking-change-analysis.md
6464
#- 4-downstream-impacts/transformation-types.md
6565
- Data Diffing:
66+
- 5-data-diffing/connect-to-warehouse.md
6667
- 5-data-diffing/row-count-diff.md
6768
- 5-data-diffing/profile-diff.md
6869
- 5-data-diffing/value-diff.md

0 commit comments

Comments
 (0)