title: 'Snowflake Data Connector' sidebar_label: 'Snowflake Data Connector' description: 'Snowflake Data Connector Documentation' pagination_prev: null

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

The Snowflake Data Connector enables federated SQL queries across datasets in the Snowflake Cloud Data Warehouse (opens in a new tab).

datasets:
  - from: snowflake:DATABASE.SCHEMA.TABLE
    name: table
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin

datasets:
  - from: snowflake:DATABASE.SCHEMA.TABLE
    name: table
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin

:::info[Hint] Unquoted table identifiers should be UPPERCASED in the from field. See Identifier resolution (opens in a new tab). :::

Configuration

from

A Snowflake fully qualified table name (database.schema.table). For instance snowflake:SNOWFLAKE_SAMPLE_DATA.TPCH_SF1.LINEITEM or snowflake:TAXI_DATA."2024".TAXI_TRIPS

name

The dataset name. This will be used as the table name within Spice. The dataset name cannot be a reserved keyword (opens in a new tab) or any of the following keywords that are reserved by Snowflake:

• START
• CONNECT
• MATCH_RECOGNIZE
• SAMPLE
• TABLESAMPLE
• FROM

params

Auth

The connector supports password-based and key-pair (opens in a new tab) authentication that must be configured using spice login snowflake or using Secrets Stores (opens in a new tab). Login requires the account identifier ('orgname-accountname' format) - use Finding the organization and account name for an account (opens in a new tab) instructions.

```bash
# Password-based
SPICE_SECRET_SNOWFLAKE_ACCOUNT="<account-identifier>" \
SPICE_SECRET_SNOWFLAKE_USERNAME="<username>" \
SPICE_SECRET_SNOWFLAKE_PASSWORD="<password>" \
spice run
# Key-pair using private key file (the `<private-key-passphrase>` is optional, used for encrypted keys only)
SPICE_SECRET_SNOWFLAKE_ACCOUNT="<account-identifier>" \
SPICE_SECRET_SNOWFLAKE_USERNAME="<username>" \
SPICE_SECRET_SNOWFLAKE_PRIVATE_KEY_PATH="<path-to-private-key>" \
SPICE_SECRET_SNOWFLAKE_PRIVATE_KEY_PASSPHRASE="<private-key-passphrase>" \
spice run
# Key-pair using private key content (the `<private-key-passphrase>` is optional, used for encrypted keys only)
SPICE_SECRET_SNOWFLAKE_ACCOUNT="<account-identifier>" \
SPICE_SECRET_SNOWFLAKE_USERNAME="<username>" \
SPICE_SECRET_SNOWFLAKE_PRIVATE_KEY="<private-key-pem-content>" \
SPICE_SECRET_SNOWFLAKE_PRIVATE_KEY_PASSPHRASE="<private-key-passphrase>" \
spice run
```

or using the Spice CLI:

```bash
# Password-based
spice login snowflake -a "<account-identifier>" -u "<username>" -p "<password>"
# Key-pair (the `<private-key-passphrase>` is an optional parameter and is used for encrypted private key only)
spice login snowflake -a "<account-identifier>" -u "<username>" -k "<path-to-private-key>" -s "<private-key-passphrase>"
```

The CLI will create or update an `.env` file that looks like:
```bash
SPICE_SNOWFLAKE_ACCOUNT="account"
SPICE_SNOWFLAKE_PASSWORD="pass"
SPICE_SNOWFLAKE_USERNAME="user"
```

Configure the spicepod to load secrets from the `env` secret store: (Note: This is the default setting)

`spicepod.yaml`
```yaml
version: v1
kind: Spicepod
name: spice-app

secrets:
  - from: env
    name: env

datasets:
  - from: snowflake:DATABASE.SCHEMA.TABLE
    name: table
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin
      snowflake_username: ${env:SPICE_SNOWFLAKE_USERNAME}
      snowflake_password: ${env:SPICE_SNOWFLAKE_PASSWORD}
      snowflake_account: ${env:SPICE_SNOWFLAKE_ACCOUNT}
```

Learn more about [Env Secret Store](../secret-stores/env/).

```bash
# Password-based
kubectl create secret generic snowflake \
  --from-literal=account='<account-identifier>' \
  --from-literal=username='<username>' \
  --from-literal=password='<password>'

# Key-pair using private key file (the `<private-key-passphrase>` is optional, used for encrypted keys only)
kubectl create secret generic snowflake \
  --from-literal=account='<account-identifier>' \
  --from-literal=username='<username>' \
  --from-literal=private_key_path='<path-to-private-key>' \
  --from-literal=private_key_passphrase='<private-key-passphrase>'

# Key-pair using private key content (the `<private-key-passphrase>` is optional, used for encrypted keys only)
kubectl create secret generic snowflake \
  --from-literal=account='<account-identifier>' \
  --from-literal=username='<username>' \
  --from-file=private_key='<path-to-private-key>' \
  --from-literal=private_key_passphrase='<private-key-passphrase>'
```

`spicepod.yaml` (password-based)
```yaml
version: v1
kind: Spicepod
name: spice-app

secrets:
  - from: kubernetes:snowflake
    name: snowflake

datasets:
  - from: snowflake:DATABASE.SCHEMA.TABLE
    name: table
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin
      snowflake_username: ${snowflake:username}
      snowflake_password: ${snowflake:password}
      snowflake_account: ${snowflake:account}
```

Learn more about [Kubernetes Secret Store](../secret-stores/kubernetes/).

```bash
# Password-based
security add-generic-password -l "Snowflake Secret" \
-a spiced -s spice_snowflake_password\
-w "<password>"

# Key-pair using private key content (the `<private-key-passphrase>` is optional, used for encrypted keys only)
security add-generic-password -l "Snowflake Secret" \
-a spiced -s spice_snowflake_private_key\
-w $(cat '<path-to-private-key>')
```

`spicepod.yaml` (key-pair)
```yaml
version: v1
kind: Spicepod
name: spice-app

secrets:
  - from: keyring
    name: keyring

datasets:
  - from: snowflake:DATABASE.SCHEMA.TABLE
    name: table
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin
      snowflake_auth_type: keypair
      snowflake_username: user_name
      snowflake_private_key: ${keyring:spice_snowflake_private_key}
      snowflake_account: account_identifier
```

Learn more about [Keyring Secret Store](../secret-stores/keyring/).

Example

datasets:
  - from: snowflake:SNOWFLAKE_SAMPLE_DATA.TPCH_SF1.LINEITEM
    name: lineitem
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin

datasets:
  - from: snowflake:SNOWFLAKE_SAMPLE_DATA.TPCH_SF1.LINEITEM
    name: lineitem
    params:
      snowflake_warehouse: COMPUTE_WH
      snowflake_role: accountadmin

:::warning[Limitations]

1. Account identifier does not support the Legacy account locator in a region format (opens in a new tab). Use Snowflake preferred name in organization format (opens in a new tab).
2. The connector supports password-based and key-pair (opens in a new tab) authentication.

:::

Secrets

Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the secret stores documentation (opens in a new tab). Additionally, learn how to use referenced secrets in component parameters by visiting the using referenced secrets guide (opens in a new tab).

Cookbook

• A cookbook recipe to configure Snowflake as a data connector in Spice. Snowflake Data Connector (opens in a new tab)