Skip to content

Commit 9d2f7d5

Browse files
committed
doc(DRC-1952): Add section of Snowflake Key Pair Authentication
1 parent 8bfac55 commit 9d2f7d5

File tree

1 file changed

+35
-16
lines changed

1 file changed

+35
-16
lines changed

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

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,45 @@ 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:
18+
- **User & Password**: Traditional username and password authentication
19+
- **Key Pair**: More secure authentication using RSA key pairs
1820

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`
21+
#### Common Fields
22+
23+
| Field | Description | Examples |
24+
| ----------- | ----------------------------------------- | ------------------------ |
25+
| `account` | The Snowflake account to connect to | `xxxxxx.us-central1.gcp` |
26+
| `database` | The default database to connect to | `MYDB` |
27+
| `schema` | The default schema to connect to | `PUBLIC` |
28+
| `warehouse` | The warehouse to use when running queries | `WH_LOAD` |
29+
30+
#### User & Password Authentication
31+
32+
| Field | Description | Examples |
33+
| ---------- | ------------------------- | -------- |
34+
| `user` | The user to log in as | `MYUSER` |
35+
| `password` | The password for the user | `MYPASS` |
36+
37+
#### Key Pair Authentication
38+
39+
| Field | Description | Required |
40+
| ------------------------ | ------------------------------------------------------------------------------- | -------- |
41+
| `user` | The user to log in as | Yes |
42+
| `private_key` | Your RSA private key in PEM format or Base64-encoded DER format | Yes |
43+
| `private_key_passphrase` | Passphrase for the private key (only required if your private key is encrypted) | No |
44+
45+
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).
2746

2847

2948
### Databricks
3049

3150
We only support token-based authentication.
3251

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

0 commit comments

Comments
 (0)