执行 SQL 语句¶

为 SQL 模板使用变量¶

在某些情况下，您可能需要根据上下文更改 SQL 查询。snow sql 命令支持客户端变量替换，允许您在提交查询之前在命令中使用在本地解析的变量。 变量在 SQL 字符串中采用形式 -<% variable_name %>, and the -D (or --variable) 选项指定变量的值。

备注

您当前可以使用 SnowSQL &variable_name 和 <% variable_name %> syntax for templates. However, Snowflake recommends using the <% variable_name %> 语法。

例如，要使用客户端变量指定数据库，可以输入类似下面的命令：

snow sql -q "select * from <% database %>.logs" -D "database=dev"

执行时，该命令将替换 <% database %> 变量中的值 dev 以创建 dev.logs 文件名，然后将 select * from dev.logs SQL 查询发送到 Snowflake 进行处理。

您还可以指定多个变量输入，如下所示：

snow sql \
-q "grant usage on database <% database %> to <% role %>" \
-D "database=dev" \
-D "role=eng_rl"

此示例生成以下 SQL 查询：

grant usage on database dev to eng_rl

在 snowflake.yml 项目定义文件中存储变量¶

将变量指定为 snow sql 命令行选项可能并不总是实用的，或者您可能不想在命令行中指定敏感值。在这种情况下，您可以在 snowflake.yml 项目定义文件中定义变量和值。然后您可以以 <% ctx.env.<variable_name> %> 形式指定变量名称，而不是使用 -D "<变量> = <value>" 选项。

使用上一部分的示例，您可以将数据库和角色变量存储在 snowflake.yml 文件中，并将查询更改为：

snow sql -q "grant usage on database <% ctx.env.database %> to <% ctx.env.role %>"

在此示例中，snow sql 命令用于在项目定义文件中查找变量定义，并提取值，而不在命令行上显示它们。snowflake.yml 文件应位于当前工作目录中，或位于使用 -p 选项指定的位置中。

有关在项目定义文件中存储这些值的更多信息，请参阅 在 SQL 中使用变量。

异步运行 SQL 查询¶

Snowflake CLI 允许您异步运行一个或多个 SQL 查询。snow sql 命令不会等待结果，而是在 Snowflake 中安排查询并返回查询 ID。查询完成后，您可以使用 !result 查询命令或 SQL RESULT_SCAN 命令获得结果。

要异步运行 SQL 查询，请用 ;> 而不是 ; 结束查询，如下所示：

snow sql -q 'select "My async query" ;>'

以下示例异步运行单个查询：

snow sql -q "select 'This is async query';>"

select 'This is async query'
+--------------------------------------+
| scheduled query ID                   |
|--------------------------------------|
| 01bc3011-080f-f2d7-0001-c1be14bae7c2 |
+--------------------------------------+

然后，您可以在 !result 查询命令中使用返回的查询 ID，用于显示查询结果：

snow sql -q '!result 01bc3011-080f-f2d7-0001-c1be14bae7c2'

path-to-private-key-file
+-----------------------+
| 'THIS IS ASYNC QUERY' |
|-----------------------|
| This is async query   |
+-----------------------+

您还可以在查询字符串中异步和同步执行多项查询，如下所示：

snow sql -q "select 'This is async query';> select 'Not an async query'; select 'Another async query';>"

select 'This is async query'
+--------------------------------------+
| scheduled query ID                   |
|--------------------------------------|
| 01bc3b8c-0109-2e81-0000-0f2d0e5a4a32 |
+--------------------------------------+

select 'Not an async query';
+----------------------+
| 'NOT AN ASYNC QUERY' |
|----------------------|
| Not an async query   |
+----------------------+

select 'Another async query'
+--------------------------------------+
| scheduled query ID                   |
|--------------------------------------|
| 01bc3b8c-0109-2e81-0000-0f2d0e5a4a36 |
+--------------------------------------+

使用 SQL 查询命令¶

Snowflake CLI 提供以下命令供您在 SQL 查询中使用：

• !source，在本地文件或 URLs 中执行 SQL。

• !queries，列出所有 SQL 查询。

• !result，显示 SQL 查询的结果。

• !abort，中止活动的 SQL 查询。

snow sql -q '!source my_sql_code.sql'

select emp_id FROM employees;
!source code_file_2.sql

snow sql -q '!result 01bc3011-080f-f2d7-0001-c1be14bae7c2'

+-----------------------+
| 'THIS IS ASYNC QUERY' |
|-----------------------|
| This is async query   |
+-----------------------+

snow sql -q '!abort 01bc3011-080f-f2d7-0001-c1be14bae7c2'

+-------------------------------------------------------------+
| SYSTEM$CANCEL_QUERY('01BC3011-080F-F2D7-0001-C1BE14BAE7C2') |
|-------------------------------------------------------------|
| Identified SQL statement is not currently executing.        |
+-------------------------------------------------------------+

在单个事务中输入多个命令¶

--single-transaction 选项允许您输入多个 SQL 命令，并将它们作为一个“要么全部执行，要么全部回滚”的命令集合来执行。将命令作为一个事务执行，可以确保所有命令都成功完成后才提交更改。如果其中任何一个命令失败，之前已成功命令所做的更改也不会被保留。

以下示例展示了事务执行成功和失败的情况：

• 命令执行成功

  snow sql -q "insert into my_tbl values (123); insert into my_tbl values (124);" --single-transaction
  

  Copy

  BEGIN;
  +----------------------------------+
  | status                           |
  |----------------------------------|
  | Statement executed successfully. |
  +----------------------------------+
  
  insert into my_tbl values (123);
  +-------------------------+
  | number of rows inserted |
  |-------------------------|
  | 1                       |
  +-------------------------+
  
  insert into my_tbl values (124);
  +-------------------------+
  | number of rows inserted |
  |-------------------------|
  | 1                       |
  +-------------------------+
  
  COMMIT
  +----------------------------------+
  | status                           |
  |----------------------------------|
  | Statement executed successfully. |
  +----------------------------------+
  

  然后，您可以验证命令是否已提交到数据库中：

  snow sql -q "select count(*) from my_tbl"
  

  Copy

  select count(*) from my_tbl
  +----------+
  | COUNT(*) |
  |----------|
  | 2        |
  +----------+
  

• 单个事务失败

  snow sql -c patcli -q "insert into my_tbl values (123); insert into my_tbl values (124); select BAD;" --single-transaction
  

  Copy

  BEGIN;
  +----------------------------------+
  | status                           |
  |----------------------------------|
  | Statement executed successfully. |
  +----------------------------------+
  
  insert into my_tbl values (123);
  +-------------------------+
  | number of rows inserted |
  |-------------------------|
  | 1                       |
  +-------------------------+
  
  insert into my_tbl values (124);
  +-------------------------+
  | number of rows inserted |
  |-------------------------|
  | 1                       |
  +-------------------------+
  
  select BAD;
  ╭─ Error ───────────────────────────────────────────────────────────────────────────────╮
  │ 000904 (42000): 01bc3b84-0810-0247-0001-c1be14ee11ce: SQL compilation error: error    │
  │ line 1 at position 7                                                                  │
  │ invalid identifier 'BAD'                                                              │
  ╰───────────────────────────────────────────────────────────────────────────────────────╯
  

然后，您可以验证命令是否未提交到数据库中：

snow sql -q "select count(*) from my_tbl"

Copy

select count(*) from my_tbl
+----------+
| COUNT(*) |
|----------|
| 0        |
+----------+

在交互模式下输入 SQL 命令¶

snow sql 命令支持交互模式，允许您一次输入一个 SQL 命令。交互模式提供以下功能：

• 语法突出显示

  

• 输入时代码补全

  

• 可搜索的历史记录

  按 CTRL-R: 可以搜索命令历史记录：

  

• 多行输入

  如果按下 ENTER 键时，当前行末尾没有分号 (;)，光标会移动到下一行，等待输入更多命令，直到语句以分号结束为止。

  

要使用交互模式，请输入 snow sql 命令，然后输入 ENTER，如下所示：

snow sql

该命令会打开一个带有 > 提示符的子 shell，您可以在其中交互式地输入 SQL 命令：

$ snow sql
  ╭───────────────────────────────────────────────────────────────────────────────────╮
  │ Welcome to Snowflake-CLI REPL                                                     │
  │ Type 'exit' or 'quit' to leave                                                    │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  >

然后，您可以输入 SQL 命令，如下所示：

> create table my_table (c1 int);

+-------------------------------------+
| status                              |
|-------------------------------------|
| Table MY_TABLE successfully created.|
+-------------------------------------+

要退出交互模式，请输入 exit、quit 或 CTRL-D。