符号约定¶
Snowflake 文档中使用了以下符号约定。
重要
在语法和代码说明中,尖括号 (< >
)、方括号 ([ ]
)、花括号 ({ }
) 和竖线 (|
) 仅用于符号目的。为避免语法错误,请勿 在输入命令或编写代码时包涵错误。
但是,括号和花括号在 JSON 和 XML 中具有特定的含义,因此在处理 JSON 或 XML 文档/数据时必须包括括号和花括号。
语法、示例和文本¶
表示 |
描述 |
---|---|
ITEM、 |
全大写表示 Snowflake SQL 命令、关键字、参数名称或函数名称。 |
item、 |
全小写表示用户为标识符、实参或实参提供的值。 |
<item>、 |
尖括号和斜体表示用户提供的标识符、实参或实数。 |
|
圆括号在 SQL 中用于对实参或实参进行分组。 输入命令时它们是 必需的 (即必须完全按照它们显示的方式 输入)。 |
|
花括号表示标识符、实参或实参的分组。 当有多个选项可用时,花括号还与竖线一起使用,用以分隔选项。 在这两种情况下,都 不应 输入花括号。 |
|
方括号表示语句的可选部分。不应 输入它们。 在许多情况下,方括号中的项是可选的,因为提供了默认值。 |
|
竖线表示两个或多个项或值之间的选择,通常在方括号或花括号内。不应 输入方括号或花括号。 |
``...``(省略号) |
上一项可以无限次重复。 |
示例¶
在以下示例中,关键字 WORK
是可选的:
BEGIN [ WORK ]
因此,以下任一条件均有效:
BEGIN;
BEGIN WORK;
在下文中,可以使用关键字 WORK
或关键字 TRANSACTION
。不能同时使用两者。不过可以省略两者。
BEGIN [ { WORK | TRANSACTION } ]
因此,以下任何一项都是有效的:
BEGIN;
BEGIN WORK;
BEGIN TRANSACTION;
下面显示了接受一个实参的函数调用的语法。圆括号是必需的。应将 <function_name>
, <argument_name>
, and <data_type>
替换为实际名称:
create function <function_name>( <argument_name> <data_type> )
因此,以下内容是有效的:
create function my_function(my_argument integer)
下面显示了一个函数,该函数至少需要一个实参并接受可选的附加实参。
<function_name>( <argument_name> <data_type> [ , <argument_name> data_type ] ... )
因此,以下内容是有效的:
my_function(argument_1 integer)
my_function(argument_1 integer, argument_2 integer)
my_function(argument_1 integer, argument_2 integer, argument_3 varchar)
在这种情况下,还允许使用其他实参。
JSON 数据¶
表示 |
描述 |
---|---|
|
方括号是 JSON 数组分隔符。 |
|
花括号是 JSON 对象分隔符。 |
XML 数据¶
表示 |
描述 |
---|---|
|
尖括号表示 XML 元素的开始或结束。 |