Skip to content

Commit 5d236f2

Browse files
authored
Merge pull request #45 from DataRecce/feature/drc-1952-doc-support-snowflake-keypair
doc(DRC-1952): Add section of Snowflake Key Pair Authentication
2 parents 8bfac55 + fcbd167 commit 5d236f2

File tree

1 file changed

+36
-16
lines changed

1 file changed

+36
-16
lines changed

docs/5-data-diffing/connect-to-warehouse.md

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,46 @@ If you use Recce Cloud, here are the warehouse connection settings. We currently
1414
Others are coming in future releases
1515

1616
### Snowflake
17-
We only support password-based authentication.
17+
We support two authentication methods for Snowflake:
1818

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`
19+
- **User & Password**: Traditional username and password authentication
20+
- **Key Pair**: More secure authentication using RSA key pairs
21+
22+
#### Common Fields
23+
24+
| Field | Description | Examples |
25+
| ----------- | ----------------------------------------- | ------------------------ |
26+
| `account` | The Snowflake account to connect to | `xxxxxx.us-central1.gcp` |
27+
| `database` | The default database to connect to | `MYDB` |
28+
| `schema` | The default schema to connect to | `PUBLIC` |
29+
| `warehouse` | The warehouse to use when running queries | `WH_LOAD` |
30+
31+
#### User & Password Authentication
32+
33+
| Field | Description | Examples |
34+
| ---------- | ------------------------- | -------- |
35+
| `user` | The user to log in as | `MYUSER` |
36+
| `password` | The password for the user | `MYPASS` |
37+
38+
#### Key Pair Authentication
39+
40+
| Field | Description | Required |
41+
| ------------------------ | ------------------------------------------------------------------------------- | -------- |
42+
| `user` | The user to log in as | Yes |
43+
| `private_key` | Your RSA private key in PEM format or Base64-encoded DER format | Yes |
44+
| `private_key_passphrase` | Passphrase for the private key (only required if your private key is encrypted) | No |
45+
46+
For more information on setting up key pair authentication, refer to [Snowflake's key pair authentication documentation](https://docs.snowflake.com/en/user-guide/key-pair-auth).
2747

2848

2949
### Databricks
3050

3151
We only support token-based authentication.
3252

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`
53+
| Field | Description | Examples |
54+
| ----------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
55+
| `host` | The hostname of your cluster | `YOURORG.databrickshost.com` |
56+
| `http_path` | The HTTP path to your SQL Warehouse or all-purpose cluster | `/SQL/YOUR/HTTP/PATH` |
57+
| `catalog` | The catalog used to connect to the warehouse. This is optional if you are using Unity Catalog | `MY_CATALOG` |
58+
| `schema` | The default schema to connect to | `MY_SCHEMA` |
59+
| `token` | The Personal Access Token (PAT) to connect to Databricks | `dapiXXXXXXXXXXXXXXXXXXXXXXX` |

0 commit comments

Comments
 (0)