通过 SnowSQL 进行连接¶

连接时指定密码¶

密码无法通过连接参数传递。必须通过以下方式之一指定密码：

• 通过 SnowSQL 中的 交互式提示 输入（仅适用于密码）。

• 在 SnowSQL 配置文件中使用 password 选项来定义。有关详细信息，请参阅 配置默认连接设置 （本主题内容）。

• 使用 SNOWSQL_PWD 环境变量指定。有关详细信息，请参阅 使用环境变量 （本主题内容）。

使用环境变量¶

目前，环境变量只能用于预先指定一些命令行参数值，例如密码、主机、数据库等。环境变量不可用于 SnowSQL 变量替换，除非启动 SnowSQL 时在命令行上使用 -D 或者 --variable 连接参数显式指定环境变量。例如：

Linux/macOS:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY

Copy

Windows:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=%DB_KEY%

Copy

在上面的例子中，--variable 将名为 db_key 的 Snowflake 变量设置为 DB_KEY 环境变量。

在配置文件中定义命名连接¶

1. 在文本编辑器中，打开 config 配置文件。默认情况下，该文件位于：

   Linux/macOS:

   ~/.snowsql/

   Windows:

   %USERPROFILE%\.snowsql\

2. 为每个命名连接添加一个具有唯一名称的单独 [connections] 部分。

   例如，在下面可以看到，账户标识符 为 myorganization-myaccount 的 Snowflake 账户具有一个名为 my_example_connection 的连接：

   [connections.my_example_connection]
   accountname = myorganization-myaccount
   username = jsmith
   password = xxxxxxxxxxxxxxxxxxxx
   dbname = mydb
   schemaname = public
   warehousename = mywh
   

   Copy

使用命名连接来连接到 Snowflake¶

使用 -c <string> （或者 --connection <string>）连接参数来指定命名连接，其中 <string> 是在 配置文件 中定义的连接的名称。

例如，使用您在 在配置文件中定义命名连接 （本主题内容）中创建的 my_example_connection 连接进行连接：

$ snowsql -c my_example_connection

Copy

-a、--accountname¶

描述:

必需

指定 账户标识符。

该连接参数也可以在 配置文件 中设置。

值:

字符串

值也可以是环境变量：

Linux/macOS:

$SNOWSQL_ACCOUNT

Windows:

%SNOWSQL_ACCOUNT%

例如，在 Linux 或 macOS 中：

$ export SNOWSQL_ACCOUNT=myorganization-myaccount

$ snowsql -a $SNOWSQL_ACCOUNT

Copy

默认值:

无

-u、--username¶

描述:

指定用于连接到指定账户的用户的登录名。

该连接参数也可以在 配置文件 中设置。

值:

字符串

值可以是环境变量：

Linux/macOS:

$SNOWSQL_USER

Windows:

%SNOWSQL_USER%

例如，在 Linux 或 macOS 中：

$ export SNOWSQL_USER=jdoe

$ snowsql -u $SNOWSQL_USER

Copy

默认值:

无

-d、--dbname¶

描述:

指定客户端会话中默认使用的数据库（登录后可以更改）。

值:

字符串

值可以是环境变量：

Linux/macOS:

$SNOWSQL_DATABASE

Windows:

%SNOWSQL_DATABASE%

该连接参数也可以在 配置文件 中设置。

默认值:

无

-s、--schemaname¶

描述:

指定客户端会话中默认使用的数据库架构（登录后可以更改）。

值:

字符串

值可以是环境变量：

Linux/macOS:

$SNOWSQL_SCHEMA

Windows:

%SNOWSQL_SCHEMA%

该连接参数也可以在 配置文件 中设置。

默认值:

无

-r、--rolename¶

描述:

指定客户端会话中默认用于访问 Snowflake 对象的角色（登录后可以更改）。

该连接参数也可以在 配置文件 中设置。

值:

字符串

值可以是环境变量：

Linux/macOS:

$SNOWSQL_ROLE

Windows:

%SNOWSQL_ROLE%

默认值:

无

-w、--warehouse¶

描述:

指定客户端会话中默认用于查询、加载等操作的虚拟仓库（登录后可以更改）。

该连接参数也可以在 配置文件 中设置。

值:

字符串

值可以是环境变量：

Linux/macOS:

$SNOWSQL_WAREHOUSE

Windows:

%SNOWSQL_WAREHOUSE%

默认值:

无

-h , --host – 已弃用¶

描述:

为向后兼容性/内部使用而提供

指定您在 Snowflake 中连接的主机的地址。

该参数不再使用，因为主机地址通过以下方式自动确定：将您使用 -a 或 --account 指定的账户标识符与 Snowflake 域 (snowflakecomputing.cn) 连接起来。

值:

字符串

默认值:

无

-p , --port – 已弃用¶

描述:

为向后兼容性/内部使用而提供

指定用于连接的端口号。

该参数不再使用，因为 Snowflake 的端口号始终为 443。

值:

字符串

默认值:

无

--region – 已弃用¶

描述:

为向后兼容性/内部使用而提供

指定账户所在 区域 的 ID。

该参数不再使用。有关更多详细信息，请参阅 -a、--accountname （本主题内容）。

值:

不适用

默认值:

不适用

-m、--mfa-passcode¶

描述:

指定 MFA（多重身份验证）的第二个令牌（如果您在命令行中传入密码）。

值:

字符串

默认值:

无

--mfa-passcode-in-password¶

描述:

在密码末尾追加 MFA 密码。

您可以强制显示密码提示，并键入后跟 MFA 密码的密码。例如，如果 MFA 令牌是 123456，并且密码是 PASSWORD：

$ snowsql ... -P ...

Password: PASSWORD123456

Copy

值:

不适用（参数不带值）

默认值:

不适用

--abort-detached-query¶

描述:

如果客户端和服务器之间的连接丢失，则中止查询。

值:

布尔

默认值:

False（即，如果连接丢失，活动的查询不会中止）

--probe-connection¶

描述:

测试与 Snowflake 的连接并报告结果。请注意，这是一个试验性选项，主要用于打印出 TLS 证书链。

值:

不适用（参数不带值）

默认值:

不适用

--authenticator¶

描述:

指定用于验证用户登录凭据的身份验证器。

值:

字符串（常量）：

• snowflake 使用内部 Snowflake 身份验证器。

• externalbrowser 使用您的 Web 浏览器 与 Okta、 AD FS 或已为账户定义的其他兼容 SAML 2.0 的身份提供商 (IdP) 进行身份验证。

• https://<okta_account_name>.okta.com （即 Okta 的 URL 端点） 通过原生 Okta 进行身份验证 （仅当 IdP 是 Okta 时才受支持）。

• oauth 使用 OAuth 进行身份验证。如果将 OAuth 指定为身份验证器，则还必须设置 --token 参数来指定 OAuth 令牌（参阅下文）。

有关更多信息，请参阅 管理/使用联合身份验证 和 客户端、驱动程序和连接器。

默认值:

snowflake

备注

仅在具有 Web 浏览器访问权限的终端窗口中，才支持 externalbrowser 身份验证器。例如，通过 SSH （安全外壳）会话访问的远程计算机上的终端窗口可能需要额外的设置才能打开 Web 浏览器。

如果您无权访问 Web 浏览器，但 IdP 是 Okta，则可以使用原生 Okta（即将身份验证器设置为 https://<okta_account_name>.okta.com）。

--token¶

描述:

指定要用于身份验证的 OAuth 令牌。仅当您指定 --authenticator=oauth 后，才需要此参数。

值:

字符串

默认值:

无

-v、--version¶

描述:

使用指定的 SnowSQL 版本，或者，如果未指定版本，则显示已安装的最新 SnowSQL 版本。

值:

字符串

默认值:

无

--versions¶

描述:

列出可以安装并运行的所有 SnowSQL 可用版本。要安装列表中较早的 SnowSQL 版本，请使用 -v 选项并指定您要安装的版本。

值:

不适用（参数不带值）

默认值:

不适用

--noup¶

描述:

本次运行禁止自动升级。如果未包含此选项，并且有更新的版本可用， SnowSQL 会自动下载并安装新版本。下次运行 SnowSQL 时会使用新版本。

值:

不适用（参数不带值）

默认值:

不适用

-D、--variable¶

描述:

在命令行上定义 SnowSQL 变量。此选项可用于设置要在 Snowflake 中使用的特定变量。

值:

字符串

例如：

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY ...

Copy

默认值:

无

-o、--option¶

描述:

在命令行上定义 SnowSQL 配置选项。这些选项将替换已在 SnowSQL 配置文件中设置的任何选项。有关可以设置/替换的选项的说明，请参阅 SnowSQL 配置选项参考。

值:

字符串

默认值:

无

-f、--filename¶

描述:

指定要以批处理模式执行的 SQL 文件。

值可以是文件名（如果需要，包含目录路径）或文件的 URL。

值:

字符串

默认值:

无

-q、--query¶

描述:

指定要执行的 SQL 查询。

值可以是单个 SQL 查询，或要执行的查询的列表（以分号分隔，例如 'select current_user(); select current_role()'）。

您还可以使用 ;> 来分隔查询，以指定多个异步运行的查询。下面的例子启动 SnowSQL，并异步运行所有四个查询：

snowsql -o log_level=DEBUG -q "select * from SNOWSQLTABLE;> insert into table table1 values(2);> select 5;>select count(*) from testtable;"

值:

字符串

默认值:

无

--query_tag¶

描述:

指定运行查询时使用的标签。

值可以是单个标签，或是以分号分隔的标签列表。

值:

字符串

默认值:

SNOWSQL_QUERY_TAG 环境变量的值。

--config¶

描述:

指定 SnowSQL 配置文件的位置（即目录路径）。如果要从默认位置移动或复制配置文件，请包含此连接器参数。

值:

字符串

默认值:

特定于 OS：

Linux/macOS:

~/.snowsql/

Windows:

%USERPROFILE%\.snowsql\

-P、--prompt¶

描述:

强制显示交互式密码提示。

默认情况下， SnowSQL 使用存储在 $SNOWSQL_PWD 环境变量中的密码。使用此选项允许您替换在 $SNOWSQL_PWD 中定义的密码。

值:

不适用（参数不带值）

默认值:

不适用

-M、--mfa-prompt¶

描述:

强制显示 MFA 的第二个令牌的提示。或者，如果想在命令行中传入密码，则使用 --mfa-passcode <string>。

值:

不适用（参数不带值）

默认值:

不适用

-c、--connection¶

描述:

指定要使用的连接，其中指定的字符串是在 SnowSQL 配置文件中定义的连接的名称。有关更多详细信息，请参阅 使用命名连接 （本主题内容）。

值:

字符串

默认值:

无

--single-transaction¶

描述:

结合 --filename、 --query 或标准输入命令使用时，此选项会将语句放入 BEGIN/COMMIT 内，以确保所有命令成功完成或不应用更改。

值:

不适用（参数不带值）

默认值:

不适用

备注

请注意，如果输入命令使用 BEGIN、 COMMIT 或者 ROLLBACK，此选项将无法正常工作。此外，如果任何命令无法在事务块内执行，此选项将导致命令失败。

--private-key-path¶

描述:

私钥文件的路径。

小心

虽然支持未加密的私钥，但 Snowflake 强烈建议在连接到 Snowflake 时使用加密的私钥。

有关更多信息，请参阅 使用密钥对身份验证和密钥对轮换。

该连接参数也可以在 配置文件 中设置。

值:

字符串

默认值:

无

--disable-request-pooling¶

描述:

默认情况下，SnowSQL 使用连接池。连接池通常可减少建立连接的滞后时间。但是，如果出现 DNS 问题，连接池可能会减慢将客户端故障转移到备选 DNS 的速度。该参数允许您关闭连接池。

该参数仅适用于启用了 复制 的客户。

值:

不适用（参数不带值）

默认值:

不适用

-U、--upgrade¶

描述:

如果本地目录中未下载最新版本，则强制将 SnowSQL 升级到最新版本。

值:

不适用（参数不带值）

默认值:

不适用

备注

需要 SnowSQL 1.1.63 或更新版本的引导程序可执行文件。可通过 UI 下载它。

-K、--client-session-keep-alive¶

描述:

即使用户没有进行任何活动，也让会话无限期地处于活动状态。

值:

不适用（参数不带值）

默认值:

不适用

--include_connector_version¶

描述:

显示以 SnowSQL 二进制打包的 Snowflake Connector for Python 软件的版本。

值:

不适用（参数不带值）

默认值:

不适用

-?、--help¶

描述:

显示命令行快速使用指南。

值:

不适用（参数不带值）

默认值:

不适用