Skip to content

Commit 3ea0e8d

Browse files
KSDaemonKSDaemon
committed
update snowflake docs
1 parent da2da5f commit 3ea0e8d

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

‎docs/pages/product/configuration/data-sources/snowflake.mdx‎

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ redirect_from:
1212
- [The region][snowflake-docs-regions] for the [Snowflake][snowflake] warehouse
1313
- The username/password for the [Snowflake][snowflake] account
1414

15-
## Snowflake quoted identifiers
15+
## Snowflake quoted identifiers
1616

17-
Due to an issue in snowflakes opinion about quoted identifers we set a session value to override
17+
Due to an issue in snowflakes opinion about quoted identifers we set a session value to override
1818
snowflake defaults for users that have set an account value for: QUOTED_IDENTIFIERS_IGNORE_CASE
1919
you can learn more about this here: https://docs.snowflake.com/en/sql-reference/identifiers-syntax#double-quoted-identifiers
2020

2121
## Setup
2222

2323
<WarningBox>
24-
If you're having Network error and Snowflake can't be reached please make sure you tried
24+
If you're having Network error and Snowflake can't be reached please make sure you tried
2525
[format 2 for an account id][snowflake-format-2].
2626
</WarningBox>
2727

@@ -65,21 +65,25 @@ if [dedicated infrastructure][ref-dedicated-infra] is used. Check out the
6565

6666
## Environment Variables
6767

68-
| Environment Variable | Description | Possible Values | Required |
69-
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | :------: |
70-
| `CUBEJS_DB_SNOWFLAKE_ACCOUNT` | The Snowflake account identifier to use when connecting to the database | [A valid Snowflake account ID][snowflake-docs-account-id] | ✅ |
71-
| `CUBEJS_DB_SNOWFLAKE_REGION` | The Snowflake region to use when connecting to the database | [A valid Snowflake region][snowflake-docs-regions] | ❌ |
72-
| `CUBEJS_DB_SNOWFLAKE_WAREHOUSE` | The Snowflake warehouse to use when connecting to the database | [A valid Snowflake warehouse][snowflake-docs-warehouse] in the account | ✅ |
73-
| `CUBEJS_DB_SNOWFLAKE_ROLE` | The Snowflake role to use when connecting to the database | [A valid Snowflake role][snowflake-docs-roles] in the account | ❌ |
74-
| `CUBEJS_DB_SNOWFLAKE_CLIENT_SESSION_KEEP_ALIVE` | If `true`, [keep the Snowflake connection alive indefinitely][snowflake-docs-connection-options] | `true`, `false` | ❌ |
75-
| `CUBEJS_DB_NAME` | The name of the database to connect to | A valid database name | ✅ |
76-
| `CUBEJS_DB_USER` | The username used to connect to the database | A valid database username | ✅ |
77-
| `CUBEJS_DB_PASS` | The password used to connect to the database | A valid database password | ✅ |
78-
| `CUBEJS_DB_SNOWFLAKE_AUTHENTICATOR` | The type of authenticator to use with Snowflake. Use `SNOWFLAKE` with username/password, or `SNOWFLAKE_JWT` with key pairs. Defaults to `SNOWFLAKE` | `SNOWFLAKE`, `SNOWFLAKE_JWT` | ❌ |
79-
| `CUBEJS_DB_SNOWFLAKE_PRIVATE_KEY_PATH` | The path to the private RSA key folder | A valid path to the private RSA key | ❌ |
80-
| `CUBEJS_DB_SNOWFLAKE_PRIVATE_KEY_PASS` | The password for the private RSA key. Only required for encrypted keys | A valid password for the encrypted private RSA key | ❌ |
81-
| `CUBEJS_DB_MAX_POOL` | The maximum number of concurrent database connections to pool. Default is `20` | A valid number | ❌ |
82-
| `CUBEJS_CONCURRENCY` | The number of [concurrent queries][ref-data-source-concurrency] to the data source | A valid number | ❌ |
68+
| Environment Variable | Description | Possible Values | Required |
69+
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | :------: |
70+
| `CUBEJS_DB_SNOWFLAKE_ACCOUNT` | The Snowflake account identifier to use when connecting to the database | [A valid Snowflake account ID][snowflake-docs-account-id] | ✅ |
71+
| `CUBEJS_DB_SNOWFLAKE_REGION` | The Snowflake region to use when connecting to the database | [A valid Snowflake region][snowflake-docs-regions] | ❌ |
72+
| `CUBEJS_DB_SNOWFLAKE_WAREHOUSE` | The Snowflake warehouse to use when connecting to the database | [A valid Snowflake warehouse][snowflake-docs-warehouse] in the account | ✅ |
73+
| `CUBEJS_DB_SNOWFLAKE_ROLE` | The Snowflake role to use when connecting to the database | [A valid Snowflake role][snowflake-docs-roles] in the account | ❌ |
74+
| `CUBEJS_DB_SNOWFLAKE_CLIENT_SESSION_KEEP_ALIVE` | If `true`, [keep the Snowflake connection alive indefinitely][snowflake-docs-connection-options] | `true`, `false` | ❌ |
75+
| `CUBEJS_DB_NAME` | The name of the database to connect to | A valid database name | ✅ |
76+
| `CUBEJS_DB_USER` | The username used to connect to the database | A valid database username | ✅ |
77+
| `CUBEJS_DB_PASS` | The password used to connect to the database | A valid database password | ✅ |
78+
| `CUBEJS_DB_SNOWFLAKE_AUTHENTICATOR` | The type of authenticator to use with Snowflake. Use `SNOWFLAKE` with username/password, or `SNOWFLAKE_JWT` with key pairs. Defaults to `SNOWFLAKE` | `SNOWFLAKE`, `SNOWFLAKE_JWT`, `OAUTH` | ❌ |
79+
| `CUBEJS_DB_SNOWFLAKE_PRIVATE_KEY` | The content of the private RSA key | Content of the private RSA key (encrypted or not) | ❌ |
80+
| `CUBEJS_DB_SNOWFLAKE_PRIVATE_KEY_PATH` | The path to the private RSA key | A valid path to the private RSA key | ❌ |
81+
| `CUBEJS_DB_SNOWFLAKE_PRIVATE_KEY_PASS` | The password for the private RSA key. Only required for encrypted keys | A valid password for the encrypted private RSA key | ❌ |
82+
| `CUBEJS_DB_SNOWFLAKE_OAUTH_TOKEN_PATH` | The path to the valid oauth toket file | A valid path for the oauth token file | ❌ |
83+
| `CUBEJS_DB_SNOWFLAKE_HOST` | Host address to which the driver should connect | A valid hostname | ❌ |
84+
| `CUBEJS_DB_SNOWFLAKE_QUOTED_IDENTIFIERS_IGNORE_CASE` | Whether or not quoted identifiers should be case insensitive. Default is `false` | `true`, `false` | ❌ |
85+
| `CUBEJS_DB_MAX_POOL` | The maximum number of concurrent database connections to pool. Default is `20` | A valid number | ❌ |
86+
| `CUBEJS_CONCURRENCY` | The number of [concurrent queries][ref-data-source-concurrency] to the data source | A valid number | ❌ |
8387

8488
[ref-data-source-concurrency]: /product/configuration/concurrency#data-source-concurrency
8589

@@ -160,8 +164,8 @@ CUBEJS_DB_EXPORT_INTEGRATION=gcs_int
160164

161165
#### Azure
162166

163-
To use Azure Blob Storage as an export bucket, follow [the guide on
164-
using a Snowflake storage integration (Option 1)][snowflake-docs-azure].
167+
To use Azure Blob Storage as an export bucket, follow [the guide on
168+
using a Snowflake storage integration (Option 1)][snowflake-docs-azure].
165169
Take note of the integration name (`azure_int` from the example link)
166170
as you'll need it to configure Cube.
167171

0 commit comments

Comments
 (0)