snow helpers import-snowsql-connections¶
从 SnowSQL 配置导入现有连接。
语法¶
实参¶
无
选项¶
--snowsql-config-file FILE指定自定义 SnowSQL 配置的文件路径。该选项可以多次用于指定多个文件。
--default-connection-name TEXT指定 Snowflake CLI 中为从 SnowSQL 导入的默认连接提供的名称。默认值:default。
--format [TABLE|JSON| JSON_EXT|CSV]指定输出格式。默认:TABLE。
--verbose, -v显示日志级别
info及更高级别的日志条目。默认值:False。--debug显示日志级别
debug及更高级别的日志条目;调试日志包含其他信息。默认值:False。--silent关闭到控制台的中间输出。默认值:False。
--enhanced-exit-codes根据错误类型区分退出错误代码。默认值:False。
--decimal-precision INTEGERNumber of decimal places to display for decimal values. Uses Python's default precision if not specified. [env var: SNOWFLAKE_DECIMAL_PRECISION].
--help显示此命令的帮助文本。
使用说明¶
snow helpers import-snowsql-connections 命令将现有连接定义从 SnowSQL 导入到 config.toml 配置文件中。
默认情况下,该命令按照 配置 SnowSQL 主题中所述的顺序读取 SnowSQL 配置文件。如果这些配置中有多个配置定义了相同的连接,则此命令将使用最新的连接定义覆盖以前导入的连接定义。为了说明问题,假设在以下位置使用不同的参数定义了相同的 [connections.example] 连接:
配置文件的位置 |
连接定义 |
|---|---|
|
|
|
运行该命令后,Snowflake CLI config.toml 文件包含以下 [connections.example] 定义(来自优先级较高的文件):
您可以使用 --snowsql-config-file 选项替换此默认行为,并从一个或多个特定 SnowSQL 配置文件导入。
snow helpers import-snowsql-connections 命令还会从 SnowSQL 导入默认连接,默认连接不是命名连接。直接在配置文件的 [connections] 部分对其进行定义。因为 Snowflake CLI 要求所有连接都是命名连接,所以该命令定义了一个名为 [default] 的连接。如果要为默认连接使用其他名称,可以使用 --default-connection-name 选项对其进行指定。
如果 SnowSQL 连接与现有 Snowflake CLI 连接的名称匹配,命令提示符会询问是要覆盖现有连接,还是跳过导入该 SnowSQL 连接。
示例¶
以下示例从标准配置文件位置导入 SnowSQL 连接:
该命令在处理 SnowSQL 配置文件时,会显示进度,并在 Snowflake CLI config.toml 文件中已经定义了同名连接时提示确认。