Installing SnowSQL¶

Setting the download directory and configuration file location¶

By default, the SnowSQL installer downloads the binaries to the following directory:

~/.snowsql

Consequently, the configuration file is located under the download directory:

~/.snowsql/config

To change both the download directory and location of the configuration file, set the WORKSPACE environment variable to any user-writable directory. This approach is particularly useful if you have an isolated SnowSQL environment for each process.

In addition, you can separate the download directory from the configuration file by setting the SNOWSQL_DOWNLOAD_DIR environment variable so that multiple SnowSQL processes can share the binaries. For example:

$ SNOWSQL_DOWNLOAD_DIR=/var/shared snowsql -h

Copy

Note that SNOWSQL_DOWNLOAD_DIR is supported starting with the SnowSQL 1.1.70 bootstrap version. To check the version you are using, execute the following command from the terminal window prompt:

$ snowsql --bootstrap-version

Copy

Downloading the SnowSQL installer¶

Go to the SnowSQL Download (https://developers.snowflake.com/snowsql/) page, find the version of the SnowSQL that you want to install, and download the files with the following filename extensions:

• .bash (the installer script)

• .bash.sig (the signature that you can use to verify the downloaded package)

Using curl to download the SnowSQL installer¶

If you want to download the installer from a script or a terminal window (such as using curl (https://curl.se/), rather than your web browser), you can download the installers directly from the Snowflake Client Repository. For increased flexibility, Snowflake provides both Amazon Web Services (AWS) and Azure endpoints for the repository. Accounts hosted on any supported cloud platform can download the installer from either endpoint.

Run curl (or an equivalent command line tool) to download the installer. The curl syntax is as follows:

AWS endpoint:

$ curl -O https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/linux_x86_64/snowsql-<version>-linux_x86_64.bash

Copy

Microsoft Azure endpoint:

$ curl -O https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/linux_x86_64/snowsql-<version>-linux_x86_64.bash

Copy

Where:

• <version> is the combined SnowSQL major, minor, and patch versions. For example, for version 1.3.1, the major version is 1, the minor version is 3, and the patch version is 1. So, the version is 1.3.1.

• <bootstrap_version> is the combined SnowSQL major and minor versions. For example, for version 1.3.1, the major version is 1 and the minor version is 23, so the bootstrap version is 1.3.

For example, to download the SnowSQL installer where <bootstrap_version> is 1.3 and <version> is 1.3.2:

AWS endpoint:

$ curl -O https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/1.3/linux_x86_64/snowsql-1.3.2-linux_x86_64.bash

Microsoft Azure endpoint:

$ curl -O https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/1.3/linux_x86_64/snowsql-1.3.2-linux_x86_64.bash

For more information about SnowSQL versions, see Understanding SnowSQL Versioning (in this topic).

Verifying the package signature¶

To verify the signature for the downloaded package:

1. Download and import the latest Snowflake GPG public key from the Classic Console or the public keyserver.

   Download from the web interface:

   1. In the Classic Console, select Help » Download… to display the Downloads dialog.

   2. Select CLI Client (snowsql) on the left, then select the Snowflake GPG Public Key icon on the right.

   Download from the keyserver:

   Enter the following command, using the GPG key associated with the SnowSQL version:

   • For SnowSQL 1.2.24 and higher:

     $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 630D9F3CAB551AF3

   • For SnowSQL version 1.2.11 through 1.2.23:

     $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 37C7086698CB005C

   • For SnowSQL version 1.1.75 through 1.2.10:

     $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys EC218558EABB25A1

   • For SnowSQL version 1.1.74 and lower:

     $ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 93DB296A69BE019A

   Note

   If this command fails with the following error:

   gpg: keyserver receive failed: Server indicated a failure
   

   Copy

   then specify that you want to use port 80 for the keyserver:

   gpg --keyserver hkp://keyserver.ubuntu.com:80  ...
   

   Copy

2. Download the GPG signature and verify the signature:

   # If you prefer to use curl to download the signature file, run this command:
   curl -O \https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/1.3/linux_x86_64/snowsql-\ |snowsql-version|\ -linux_x86_64.bash.sig
   
   # Verify the package signature.
   gpg --verify snowsql-\ |snowsql-version|\ -linux_x86_64.bash.sig snowsql-\ |snowsql-version|\ -linux_x86_64.bash
   

   Copy

   or, if you are downloading the signature file from the Azure endpoint:

   # If you prefer to use curl to download the signature file, run this command:
   curl -O \https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/1.3/linux_x86_64/snowsql-\ |snowsql-version|\ -linux_x86_64.bash.sig
   
   # Verify the package signature.
   gpg --verify snowsql-\ |snowsql-version|\ -linux_x86_64.bash.sig snowsql-\ |snowsql-version|\ -linux_x86_64.bash
   

   Copy

   Note

   Verifying the signature produces a warning similar to the following:

   gpg: Signature made Mon 24 Sep 2018 03:03:45 AM UTC using RSA key ID <gpg_key_id>
   gpg: Good signature from "Snowflake Computing <snowflake_gpg@snowflake.net>" unknown
   gpg: WARNING: This key is not certified with a trusted signature!
   gpg: There is no indication that the signature belongs to the owner.
   

   Copy

   To avoid the warning, you can grant the Snowflake GPG public key implicit trust.

3. Your local environment can contain multiple GPG keys; however, for security reasons, Snowflake periodically rotates the public GPG key. As a best practice, we recommend deleting the existing public key after confirming that the latest key works with the latest signed package. For example:

   gpg --delete-key "Snowflake Computing"
   

   Copy

Installing SnowSQL using the installer¶

1. Open a terminal window.

2. Run the Bash script installer from the download location:

   bash snowsql-linux_x86_64.bash
   

   Copy

3. Follow the instructions provided by the installer.

SNOWSQL_DEST=~/bin SNOWSQL_LOGIN_SHELL=~/.profile bash snowsql-linux_x86_64.bash

When you install a new major or minor version, SnowSQL does not upgrade itself immediately. Rather, you must log into your Snowflake account using SnowSQL and remain connected for a sufficient period of time for the auto-upgrade feature to upgrade the client to the latest release. To verify the SnowSQL version that currently starts when you run the client, use the -v option without a value:

snowsql -v

Copy

Version: 1.3.1

To force SnowSQL to install and use a specific version, use the -v option and specify the version you want to install. For example, execute the following command for version 1.3.0:

snowsql -v 1.3.0

Copy

Downloading the SnowSQL RPM package¶

Go to the SnowSQL Download (https://developers.snowflake.com/snowsql/) page, find the version of the SnowSQL that you want to install, and download the file with the .rpm filename extension.

Installing the SnowSQL RPM package¶

The downloaded RPM file can be installed the way that any other RPM package is installed:

rpm -i <package_name>

Setting the download directory and configuration file location¶

By default, the SnowSQL installer downloads the binaries to the following directory:

~/.snowsql

Consequently, the configuration file is located under the download directory:

~/.snowsql/config

You can change both the download directory and location of the configuration file by setting the WORKSPACE environment variable to any user-writable directory. This is particularly useful if you have an isolated SnowSQL environment for each process.

In addition, you can separate the download directory from the configuration file by setting the SNOWSQL_DOWNLOAD_DIR environment variable so that multiple SnowSQL processes can share the binaries. For example:

SNOWSQL_DOWNLOAD_DIR=/var/shared snowsql -h

Copy

Note that SNOWSQL_DOWNLOAD_DIR is supported starting with the SnowSQL 1.1.70 bootstrap version. To check the version you are using, execute the following command from the terminal window prompt:

snowsql --bootstrap-version

Copy

Downloading the SnowSQL installer¶

To download the SnowSQL installer, go to the SnowSQL Download (https://developers.snowflake.com/snowsql/) page. This version of the SnowSQL installer enables auto-upgrade for patches.

Using curl to download the SnowSQL installer¶

If you want to download the installer from a script or a terminal window (such as using curl (https://curl.se/), rather than your web browser), you can download the installers directly from the Snowflake Client Repository. For increased flexibility, Snowflake provides both Amazon Web Services (AWS) and Azure endpoints for the repository. Accounts hosted on any supported cloud platform can download the installer from either endpoint.

Run curl (or an equivalent command line tool) to download the installer. The curl syntax is as follows:

AWS endpoint:

curl -O https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/darwin_x86_64/snowsql-<version>-darwin_x86_64.pkg

Copy

Microsoft Azure endpoint:

curl -O https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/darwin_x86_64/snowsql-<version>-darwin_x86_64.pkg

Copy

where:

• <version> is the combined SnowSQL major, minor, and patch versions. For example, for version 1.3.1, the major version is 1, the minor version is 3, and the patch version is 1. So, the version is 1.3.1.

• <bootstrap_version> is the combined SnowSQL major and minor versions. For example, for version 1.3.1, the major version is 1 and the minor version is 3, so the bootstrap version is 1.3.

For example, to download the SnowSQL installer where <bootstrap_version> is 1.3 and <version> is 1.3.2:

AWS endpoint:

curl -O \https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/1.3/darwin_x86_64/snowsql-\ |snowsql-version|\ -darwin_x86_64.pkg

Copy

Microsoft Azure endpoint:

curl -O \https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/1.3/darwin_x86_64/snowsql-\ |snowsql-version|\ -darwin_x86_64.pkg

Copy

For more information about SnowSQL versions, see Understanding SnowSQL Versioning (in this topic).

The macOS operating system can verify the installer signature automatically, so GPG signature verification is not needed.

Installing SnowSQL using the installer¶

1. Open snowsql-darwin_x86_64.pkg in the download location to run the installer PKG file.

2. Follow the instructions provided by the installer.

installer -pkg snowsql-darwin_x86_64.pkg -target CurrentUserHomeDirectory

When you install a new major or minor version, SnowSQL does not upgrade itself immediately. Rather, you must log into your Snowflake account using SnowSQL and remain connected for a sufficient period of time for the auto-upgrade feature to upgrade the client to the latest release. To verify the SnowSQL version that currently starts when you run the client, use the -v option without a value:

snowsql -v

Copy

Version: 1.3.0

To force SnowSQL to install and use a specific version, use the -v option and specify the version you want to install. For example, execute the following command for version 1.3.1:

snowsql -v 1.3.1

Copy

Configuring the Z shell alias (macOS only)¶

If Z shell (also known as zsh) is your default terminal shell, set an alias to the SnowSQL executable so that you can run SnowSQL on the command line in Terminal. The SnowSQL installer installs the executable in /Applications/SnowSQL.app/Contents/MacOS/snowsql and appends this path to the PATH or alias entry in ~/.profile. Because zsh does not normally read this file, add an alias to this path in ~/.zshrc, which zsh does read.

To add an alias to the SnowSQL executable:

1. Open (or create, if missing) the ~/.zshrc file.

2. Add the following line:

   alias snowsql=/Applications/SnowSQL.app/Contents/MacOS/snowsql
   

   Copy

3. Save the file.

Setting the download directory and configuration file location¶

By default, the SnowSQL installer downloads the binaries to the following directory:

%USERPROFILE%\.snowsql

Consequently, the configuration file is located under the download directory:

%USERPROFILE%\.snowsql\config

You can change both the download directory and location of the configuration file by setting the WORKSPACE environment variable to any user-writable directory. This is particularly useful if you have an isolated SnowSQL environment for each process.

In addition, you can separate the download directory from the configuration file by setting the SNOWSQL_DOWNLOAD_DIR environment variable so that multiple SnowSQL processes can share the binaries. For example:

SNOWSQL_DOWNLOAD_DIR=/var/shared snowsql -h

Copy

Note that SNOWSQL_DOWNLOAD_DIR is supported starting with the SnowSQL 1.1.70 bootstrap version. To check the version you are using, execute the following command from the terminal window prompt:

snowsql --bootstrap-version

Copy

Downloading the SnowSQL installer¶

To download the SnowSQL installer, go to the SnowSQL Download (https://developers.snowflake.com/snowsql/) page. This version of the SnowSQL installer enables auto-upgrade for patches.

Using curl to download the SnowSQL installer¶

If you want to download the installer from a script or a terminal window (such as using curl (https://curl.se/), rather than your web browser), you can download the installers directly from the Snowflake Client Repository. For increased flexibility, Snowflake provides both Amazon Web Services (AWS) and Azure endpoints for the repository. Accounts hosted on any supported cloud platform can download the installer from either endpoint.

Run curl (or an equivalent command line tool) to download the installer. The curl syntax is as follows:

AWS endpoint:

curl -O https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/windows_x86_64/snowsql-<version>-windows_x86_64.msi

Copy

Microsoft Azure endpoint:

curl -O https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/<bootstrap_version>/windows_x86_64/snowsql-<version>-windows_x86_64.msi

Copy

Where:

• <version> is the combined SnowSQL major, minor, and patch versions. For example, for version 1.3.1, the major version is 1, the minor version is 3, and the patch version is 1. So, the version is 1.3.1.

• <bootstrap_version> is the combined SnowSQL major and minor versions. For example, for version 1.3.1, the major version is 1 and the minor version is 3, so the bootstrap version is 1.3.

For example, to download the SnowSQL installer where <bootstrap_version> is 1.3 and <version> is 1.3.2:

AWS endpoint:

curl -O \https://sfc-repo.snowflakecomputing.cn/snowsql/bootstrap/1.3/windows_x86_64/snowsql-\ |snowsql-version|\ -windows_x86_64.msi

Copy

Microsoft Azure endpoint:

curl -O \https://sfc-repo.azure.snowflakecomputing.cn/snowsql/bootstrap/1.3/windows_x86_64/snowsql-\ |snowsql-version|\ -windows_x86_64.msi

Copy

For more information about SnowSQL versions, see Understanding SnowSQL Versioning (in this topic).

The Windows operating system can verify the installer signature automatically, so GPG signature verification is not needed.

Installing SnowSQL using the installer¶

1. Open snowsql-windows_x86_64.msi in the download location to run the installer MSI file.

2. Follow the instructions provided by the installer.

C:\Users\<username> msiexec /i snowsql-windows_x86_64.msi /q

When you install a new major or minor version, SnowSQL does not upgrade itself immediately. Rather, you must log into your Snowflake account using SnowSQL and remain connected for a sufficient period of time for the auto-upgrade feature to upgrade the client to the latest release. To verify the SnowSQL version that currently starts when you run the client, use the -v option without a value:

snowsql -v

Copy

Version: 1.3.1

To force SnowSQL to install and use a specific version, use the -v option and specify the version you want to install. For example, execute the following command for version 1.3.0:

snowsql -v 1.3.0

Copy

What is auto-upgrade?¶

If you choose to enable automatic upgrades for SnowSQL, SnowSQL automatically downloads the new binary in a background process and executes the current version. The next time you run SnowSQL, the new version starts.

To illustrate the process:

1. For a fresh installation, you download the SnowSQL installer (such as version 1.3.0) using the Snowflake web interface and install the client.

2. Each time you run SnowSQL, the client checks whether a newer version is available in the SnowSQL upgrade repository.

3. If a newer version (such as version 1.3.1) is available, SnowSQL downloads it as a background process while the current installed version.

4. The next time you run SnowSQL, the client executes version 1.3.1 while checking if a newer version is available.

Enabling auto-upgrade¶

The -o noup=<value> option lets you override the SnowSQL default behavior of requiring manual installations for new versions, where:

• True enables the no-upgrade behavior (Default value for version 1.3.0 and higher). SnowSQL does not automatically check for upgrades and automatically upgrades itself.

• False disables the no-upgrade behavior (Default value for version 1.2.32 and lower). SnowSQL automatically checks for upgrades and automatically upgrades itself if any new upgrade is available within the same major.minor version

You can specify this option while logging into Snowflake to enable auto-upgrade during that specific session.

For example:

snowsql -o noup=False

Copy

Alternatively, add the noup = False option to the configuration file to enable automatic upgrades for SnowSQL.

Running a previous SnowSQL version¶

If you encounter an issue with the latest SnowSQL version, such as version 1.3.1, you can temporarily run another 1.3.x version.

To determine the SnowSQL version that currently starts when you run the client, use the -v option without a value:

$ snowsql -v

  Version: 1.3.1

Copy

To display a list of available SnowSQL versions, use the --versions option:

$ snowsql --versions

 1.3.1
 1.3.0

Copy

To install an earlier SnowSQL version from the list, use the -v option and specify the version you want to install. For example, to install version 1.3.0 if you are running a newer version, such as 1.3.1:

$ snowsql -v 1.3.0

  Installing version: 1.3.0 [####################################]  100%

Copy

Use the same option to specify the version you want to run when you start SnowSQL:

$ snowsql -v 1.3.0

Copy

New users¶

To specify the Microsoft Azure endpoint of the Snowflake Client Repository as a new SnowSQL user, execute the following command:

snowsql -o repository_base_url=https://sfc-repo.azure.snowflakecomputing.cn/snowsql

Verify the configuration file (i.e. ~/.snowsql/config or %USERPROFILE%\.snowsql\config) includes the following line.

repository_base_url=https://sfc-repo.azure.snowflakecomputing.cn/snowsql

Existing users¶

To specify the Microsoft Azure endpoint of the Snowflake Client Repository as an existing SnowSQL user, add the following line to the configuration file (i.e. ~/.snowsql/config or %USERPROFILE%\.snowsql\config):

repository_base_url=https://sfc-repo.azure.snowflakecomputing.cn/snowsql