Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 35 additions & 4 deletions website/docs/connect-data/reference/querying-snowflake-db.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,44 @@ The role to use for performing queries. For example, `ACCOUNTADMIN`

</dd>

#### Username
### Authentication type

<dd>The username for your Snowflake account.</dd>
#### Basic

Basic authentication is a simple method that uses a username and password to authenticate users to Snowflake.


* **Username** - The username is the unique identifier for your Snowflake account. It is typically assigned by your Snowflake administrator or created when you set up your Snowflake account. You can find your username in your Snowflake account settings.

* **Password** - The password is the secret string of characters used in combination with your username to authenticate your identity to Snowflake. You can find your password in your Snowflake account settings.


#### Key Pair

Key Pair authentication is a secure method that uses a pair of cryptographic keys for authentication, providing enhanced security. For more information, see [Key-pair authentication](https://docs.snowflake.com/en/user-guide/key-pair-auth).


* **Username** - The username is the unique identifier for your Snowflake account. It is typically assigned by your Snowflake administrator or created when you set up your Snowflake account. You can find your username in your Snowflake account settings.

* **Private key**: The private key is a confidential cryptographic key used to sign authentication requests. It is generated during the key pair creation process and should be kept secure and encrypted. You can upload the private key file from your local machine.

* **Passphrase:** The passphrase is an optional password that you set when generating the private key. It adds an extra layer of security by encrypting the private key file.

<dd>

To generate keys for secure authentication, you can use tools like [OpenSSL](https://www.openssl.org/). With OpenSSL, you can create two keys: a private key and a public key. The private key, encrypted with AES-256, is used for signing authentication requests, while the public key is extracted from the private key for verification purposes. For more information, see [How to generate the private key](https://docs.snowflake.com/en/user-guide/key-pair-auth#generate-the-private-key).


To use the keys:

* **Public Key**: Upload the public key to your Snowflake user profile. This can be done through the Snowflake web interface or using SQL commands. The public key will be used by Snowflake to verify the signatures created with your private key.

* **Private Key**: Store this private key on your local machine and use it to configure the datasource in Appsmith. You can use the same key for multiple authentication.


</dd>

#### Password

<dd>The password for your Snowflake account.</dd>

## Query Snowflake

Expand Down
Binary file modified website/static/img/snowflake-datasource-config.png

Choose a reason for hiding this comment

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

@harshilp24 should we have one screenshot each for basic and key pair auth? The one added in this PR shows the key pair method

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we should add screenshots for each authentication method. The UI for selecting the method is simple and easy to understand; we only add screenshots when we think users might get confused or if the UI is difficult to configure.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.