Skip to content

doc(DRC-1952): Add section of Snowflake Key Pair Authentication #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
popcornylu merged 2 commits into from
Oct 22, 2025
Merged

doc(DRC-1952): Add section of Snowflake Key Pair Authentication #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d2f7d5
doc(DRC-1952): Add section of Snowflake Key Pair Authentication
iamcxa Oct 22, 2025
fcbd167
refactor: update suggestions
iamcxa Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 36 additions & 16 deletions docs/5-data-diffing/connect-to-warehouse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,46 @@ If you use Recce Cloud, here are the warehouse connection settings. We currently
Others are coming in future releases

### Snowflake
We only support password-based authentication.
We support two authentication methods for Snowflake:
Copy link
Contributor

@popcornylu popcornylu Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add additional line here.

image

Copy link
Contributor Author

@iamcxa iamcxa Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a new-line

image


Field | Description | Examples
----|------|----
`account` | The Snowflake account to connect to | `xxxxxx.us-central1.gcp`
`database` | The default database to connect to | `MYDB`
`schema` | The default schema to connect to | `PUBLIC`
`warehouse` | The warehouse to use when running queries | `WH_LOAD`
`user` | The user to log in as | `MYUSER`
`password` | The password for the user | `MYPASS`
- **User & Password**: Traditional username and password authentication
- **Key Pair**: More secure authentication using RSA key pairs

#### Common Fields

| Field | Description | Examples |
| ----------- | ----------------------------------------- | ------------------------ |
| `account` | The Snowflake account to connect to | `xxxxxx.us-central1.gcp` |
| `database` | The default database to connect to | `MYDB` |
| `schema` | The default schema to connect to | `PUBLIC` |
| `warehouse` | The warehouse to use when running queries | `WH_LOAD` |

#### User & Password Authentication

| Field | Description | Examples |
| ---------- | ------------------------- | -------- |
| `user` | The user to log in as | `MYUSER` |
| `password` | The password for the user | `MYPASS` |

#### Key Pair Authentication

| Field | Description | Required |
| ------------------------ | ------------------------------------------------------------------------------- | -------- |
| `user` | The user to log in as | Yes |
| `private_key` | Your RSA private key in PEM format or Base64-encoded DER format | Yes |
| `private_key_passphrase` | Passphrase for the private key (only required if your private key is encrypted) | No |

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).


### Databricks

We only support token-based authentication.

Field | Description | Examples
----|------|----
`host` | The hostname of your cluster | `YOURORG.databrickshost.com`
`http_path` | The HTTP path to your SQL Warehouse or all-purpose cluster | `/SQL/YOUR/HTTP/PATH`
`catalog` | The catalog used to connect to the warehouse. This is optional if you are using Unity Catalog | `MY_CATALOG`
`schema` | The default schema to connect to | `MY_SCHEMA`
`token` | The Personal Access Token (PAT) to connect to Databricks | `dapiXXXXXXXXXXXXXXXXXXXXXXX`
| Field | Description | Examples |
| ----------- | --------------------------------------------------------------------------------------------- | ----------------------------- |
| `host` | The hostname of your cluster | `YOURORG.databrickshost.com` |
| `http_path` | The HTTP path to your SQL Warehouse or all-purpose cluster | `/SQL/YOUR/HTTP/PATH` |
| `catalog` | The catalog used to connect to the warehouse. This is optional if you are using Unity Catalog | `MY_CATALOG` |
| `schema` | The default schema to connect to | `MY_SCHEMA` |
| `token` | The Personal Access Token (PAT) to connect to Databricks | `dapiXXXXXXXXXXXXXXXXXXXXXXX` |