diff --git a/docs/5-data-diffing/connect-to-warehouse.md b/docs/5-data-diffing/connect-to-warehouse.md index 7379d6f..ed69419 100644 --- a/docs/5-data-diffing/connect-to-warehouse.md +++ b/docs/5-data-diffing/connect-to-warehouse.md @@ -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: -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` |