Convenções de notação¶

As seguintes convenções de notação são utilizadas na documentação do Snowflake.

Importante

Nas descrições de sintaxe e código, os colchetes angulares (< >), colchetes ([ ]), chaves ({ }) e barras verticais (|) são usados apenas para fins de notação. Para evitar erros de sintaxe, não os inclua ao inserir um comando ou escrever um código.

Entretanto, colchetes e chaves têm significados específicos em JSON e XML, portanto devem ser incluídos quando se trabalha com documentos/dados JSON ou XML.

Sintaxe, exemplos e texto¶

Notação	Descrição
ITEM , `ITEM`	Todas letras maiúsculas indicam um comando SQL, palavra-chave, nome de parâmetro ou nome de função Snowflake.
item , `item`	Todas as letras minúsculas indicam um valor fornecido pelo usuário para um identificador, parâmetro ou argumento.
<item> , `item`	Colchetes angulares e itálico indicam identificadores, parâmetros ou argumentos que são fornecidos pelos usuários.
`( item1 item2 ... )`	Os parênteses são usados em SQL para agrupar parâmetros ou argumentos. Eles são exigidos ao inserir um comando (ou seja, devem ser digitados exatamente como aparecem).
`{ item1 item2 ... }`	As chaves indicam agrupamentos de identificadores, parâmetros ou argumentos. As chaves são também usadas com barras verticais para delimitar as escolhas quando há mais de uma opção disponível. Em ambos os casos, as chaves não devem ser inseridas.
`[ ITEM ]` , `[ item1 item2 ... ]`	Os colchetes indicam as partes opcionais de uma instrução. Eles não devem ser inseridos. Em muitos casos, os itens entre colchetes são opcionais porque os valores padrão são fornecidos.
`\|`	Uma barra vertical indica uma escolha entre dois ou mais itens ou valores, geralmente dentro de colchetes ou chaves. Os colchetes ou chaves não devem ser inseridos.
`...` (reticências)	O item anterior pode ser repetido um número indefinido de vezes.

Exemplos¶

A seguir, a palavra-chave WORK é opcional:

BEGIN [ WORK ]

Copy

Portanto, qualquer um dos dois itens a seguir é válido:

BEGIN;
BEGIN WORK;

Copy

A seguir, você pode usar a palavra-chave WORK ou a palavra-chave TRANSACTION. Você não deve usar ambos. Você pode omitir ambos.

BEGIN [ { WORK | TRANSACTION } ]

Copy

Portanto, qualquer um dos itens a seguir é válido:

BEGIN;
BEGIN WORK;
BEGIN TRANSACTION;

Copy

O seguinte mostra a sintaxe de uma chamada de função que aceita um argumento. Os parênteses são obrigatórios. <function_name>, <argument_name> e <data_type> devem ser substituídos pelos nomes reais:

create function <function_name>( <argument_name> <data_type> )

Copy

Portanto, o seguinte é válido:

create function my_function(my_argument integer)

Copy

A função a seguir requer pelo menos um argumento e aceita argumentos adicionais opcionais.

<function_name>( <argument_name> <data_type> [ , <argument_name> data_type ] ... )

Copy

Portanto, os seguintes itens são válidos:

my_function(argument_1 integer)
my_function(argument_1 integer, argument_2 integer)
my_function(argument_1 integer, argument_2 integer, argument_3 varchar)

Copy

Nesse caso, também são permitidos argumentos adicionais.

Dados JSON¶

Notação	Descrição
`[ item1 ... ]`	Os colchetes são delimitadores de matrizes JSON.
`{ item1 item2 ... }`	As chaves são delimitadores de objetos JSON.

Dados XML¶

Notação	Descrição
`<item> ... </item>`	Colchetes angulares indicam o início ou o fim de um elemento XML.