Setup
Step 1: Create a dedicated user for ClarityQ
Connect to Snowflake and create a service account:Step 2: Create and configure a role
Set up appropriate permissions through a dedicated role:Step 3: Create a ClarityQ warehouse (or use an existing one)
Step 4: Configure connection in ClarityQ
In the ClarityQ interface, fill out the connection form with the following fields:Basic Fields (Required for all connections)
- Connection Name: Choose a name for this connection (e.g., “Production Snowflake”)
- Account: Your Snowflake account identifier (e.g.,
xy12345.us-east-1) - User:
clarityq_user(the user you created in Step 1) - Warehouse: Your warehouse name (e.g.,
COMPUTE_WH) - Database: Your database name (e.g.,
ANALYTICS_DB) - DB Schema: Schema name (e.g.,
public) - Role:
clarityq_role(the role you created in Step 2)
Authentication Type
Choose your authentication method using the toggle buttons: Password Authentication:- Password: Enter the password you set for
clarityq_user
-
Private Key: Paste your RSA private key (multi-line text field)
Key-pair authentication setup:
For enhanced security, configure RSA key-pair authentication:
Generate RSA key pair:
Configure in Snowflake:
Connection parameters reference
Required parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
account | string | Snowflake account identifier with region | xy12345.us-east-1 |
user | string | Snowflake username | clarityq_user |
warehouse | string | Compute warehouse name | COMPUTE_WH |
database | string | Target database name | ANALYTICS_DB |
Optional parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
connection_name | string | - | Custom name for this connection |
db_schema | string | public | Default schema within database |
role | string | - | Snowflake role to use |
Authentication methods
Choose one of the following authentication methods:Password authentication (default)
| Parameter | Type | Description |
|---|---|---|
password | string | User password |
Key-pair authentication
| Parameter | Type | Description |
|---|---|---|
private_key | string | Private key in PEM format |