snow object create¶

Crie um objeto de um determinado tipo. Verifique a documentação para obter a lista de objetos e parâmetros compatíveis.

Sintaxe¶

snow object create
  <object_type>
  <object_attributes>
  --json <object_json>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --format <format>
  --verbose
  --debug
  --silent

Copy

Argumentos¶

object_type: Tipo de objeto. Por exemplo, tabela, banco de dados, pool de computação.
object_attributes...: Atributos de objeto fornecidos como uma lista de pares chave=valor, por exemplo name=my_db comment=”created with Snowflake CLI”. Verifique a documentação para obter a lista completa de parâmetros disponíveis para cada objeto.

Opções¶

--json TEXT: Definição de objeto no formato JSON, por exemplo “{«name»:»my_db», «comment»: «created with Snowflake CLI»}”. Verifique a documentação para obter a lista completa de parâmetros disponíveis para cada objeto.
--connection, -c, --environment TEXT: Nome da conexão, conforme definido no arquivo config.toml. Padrão: padrão.
--host TEXT: Endereço do host da conexão. Substitui o valor especificado para a conexão.
--port INTEGER: Porta para a conexão. Substitui o valor especificado para a conexão.
--account, --accountname TEXT: Nome atribuído à sua conta Snowflake. Substitui o valor especificado para a conexão.
--user, --username TEXT: Nome de usuário para se conectar ao Snowflake. Substitui o valor especificado para a conexão.
--password TEXT: Senha do Snowflake. Substitui o valor especificado para a conexão.
--authenticator TEXT: Autenticador Snowflake. Substitui o valor especificado para a conexão.
--private-key-file, --private-key-path TEXT: Caminho do arquivo de chave privada Snowflake. Substitui o valor especificado para a conexão.
--token-file-path TEXT: Caminho para o arquivo com um token OAuth que deve ser usado ao conectar-se ao Snowflake.
--database, --dbname TEXT: Banco de dados a ser usado. Substitui o valor especificado para a conexão.
--schema, --schemaname TEXT: Esquema de banco de dados a ser usado. Substitui o valor especificado para a conexão.
--role, --rolename TEXT: Função a ser usada. Substitui o valor especificado para a conexão.
--warehouse TEXT: Warehouse a ser usado. Substitui o valor especificado para a conexão.
--temporary-connection, -x: Usa conexão definida com parâmetros de linha de comando, em vez de uma definida na configuração. Padrão: falso.
--mfa-passcode TEXT: Token a ser usado para autenticação multifator (MFA).
--enable-diag: Execução do teste de diagnóstico do conector Python. Padrão: falso.
--diag-log-path TEXT: Caminho do relatório de diagnóstico. Padrão: <temporary_directory>.
--diag-allowlist-path TEXT: Caminho do relatório de diagnóstico para a lista de permissões opcional.
--format [TABLE|JSON]: Especifica o formato de saída. Padrão: TABLE.
--verbose, -v: Exibe entradas de log para níveis de log info e superior. Padrão: falso.
--debug: Exibe entradas de log para níveis de log de depuração e superiores; os logs de depuração contêm informações adicionais. Padrão: falso.
--silent: Desliga a saída intermediária para o console. Padrão: falso.

--help: Exibe o texto de ajuda para este comando.

Notas de uso¶

O comando snow object create cria um dos seguintes tipos de objetos Snowflake, com base nos atributos ou definições de objeto fornecidos:

account
catalog-integration
compute-pool
database
database-role
dynamic-table
event-table
external-volume
function
image-repository
managed-account
network-policy
notebook
notification-integration
pipe
procedure
role
schema
service
stage
stream
table
task
user-defined-function
view
warehouse

Para cada objeto, você deve especificar os detalhes apropriados do objeto usando os atributos do objeto ou as definições do objeto.

Use o parâmetro object_attributes que especifica os detalhes do objeto como uma série de pares <key>=<value>, como:
```
snow object create database name=my_db comment="Created with Snowflake CLI"
```
Copy

Use a opção --json object_definition para especificar os detalhes de objetos JSON, como:

snow object create table name=my_table columns='[{"name":"col1","datatype":"number", "nullable":false}]' constraints='[{"name":"prim_key", "column_names":["col1"], "constraint_type":"PRIMARY KEY"}]' --database my_db

Copy

Consulte Exemplos para mais exemplos.

Nota

Os seguintes tipos de objeto exigem que um banco de dados seja identificado na configuração de conexão, como config.toml, ou passado para o comando usando a opção --database.

image-repository
esquema
serviço
tabela
tarefa

As seções a seguir descrevem os atributos que a Snowflake CLI oferece suporte para tipos de objeto selecionados.

compute-pool
database
image-repository
schema
service
table
task
warehouse

É possível encontrar atributos para outros tipos de objetos verificando suas referências de comando SQL CREATE correspondentes, como CREATE ACCOUNT.

Atributos de objeto do pool de computação¶

Atributos do pool de computação¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
min_nodes obrigatório, inteiro	Número mínimo de nós para o pool de computação.
max_nodes obrigatório, inteiro	Número máximo de nós para o pool de computação.
instance_family obrigatório, cadeia de caracteres	Nome da família da instância. Para obter mais informações sobre famílias de instâncias, consulte o comando SQL CREATE COMPUTE POOL.
auto_resume opcional, cadeia de caracteres	Se o pool de computação deve ser retomado automaticamente quando qualquer instrução que exija o pool de computação for enviada.
comment opcional, cadeia de caracteres	Comentário descrevendo o pool de computação.
auto_suspend_secs opcional, cadeia de caracteres	Número de segundos de inatividade após os quais você deseja que o Snowflake suspenda automaticamente o pool de computação.

Atributos de objeto de banco de dados¶

Atributos de banco de dados¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
comment opcional, cadeia de caracteres	Comentário descrevendo o banco de dados.
data_retention_time_in_days opcional, inteiro	Número de dias durante os quais as ações de Time Travel (CLONE e UNDROP) podem ser executadas no esquema, bem como o tempo de retenção padrão de Time Travel para todas as tabelas criadas no esquema.
default_ddl_collation opcional, cadeia de caracteres	Especificação de agrupamento padrão para todos os esquemas e tabelas adicionados ao banco de dados. É possível substituir esse padrão no nível do esquema e da tabela individual.
max_data_extension_time_in_days opcional, inteiro	Número máximo de dias durante os quais o Snowflake pode estender o período de retenção de dados para tabelas no banco de dados para evitar que os fluxos nas tabelas fiquem obsoletos.
suspend_task_after_num_failures opcional, inteiro	Número de execuções consecutivas de tarefa com falha após as quais a tarefa atual é suspensa automaticamente.
user_task_managed_initial_warehouse_size opcional, inteiro	Tamanho dos recursos de computação a serem provisionados para a primeira execução da tarefa, antes que um histórico de tarefa esteja disponível para o Snowflake determinar um tamanho ideal. Os valores possíveis incluem: XSMALL, SMALL, MEDIUM, LARGE e XLARGE.
user_task_timeout_ms opcional, inteiro	Limite de tempo, em milissegundos, para uma única execução da tarefa antes que o tempo limite seja atingido.

Atributos do objeto do repositório de imagens¶

Atributos do repositório de imagens¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.

Atributos do objeto esquema¶

Atributos de esquema¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
comment opcional, cadeia de caracteres	Comentário descrevendo o esquema.
data_retention_time_in_days opcional, inteiro	Número de dias durante os quais as ações de Time Travel (CLONE e UNDROP) podem ser executadas no esquema, bem como o tempo de retenção padrão de Time Travel para todas as tabelas criadas no esquema.
default_ddl_collation opcional, cadeia de caracteres	Especificação de agrupamento padrão para todos os esquemas e tabelas adicionados ao banco de dados. É possível substituir esse padrão no nível do esquema e da tabela individual.
max_data_extension_time_in_days opcional, inteiro	Número máximo de dias durante os quais o Snowflake pode estender o período de retenção de dados para tabelas no banco de dados para evitar que os fluxos nas tabelas fiquem obsoletos.
suspend_task_after_num_failures opcional, inteiro	Número de execuções consecutivas de tarefa com falha após as quais a tarefa atual é suspensa automaticamente.
user_task_managed_initial_warehouse_size opcional, inteiro	Tamanho dos recursos de computação a serem provisionados para a primeira execução da tarefa, antes que um histórico de tarefa esteja disponível para o Snowflake determinar um tamanho ideal.
user_task_timeout_ms opcional, inteiro	Limite de tempo, em milissegundos, para uma única execução da tarefa antes que o tempo limite seja atingido.

Atributos do objeto de serviço¶

Atributos de serviço¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
compute_pool obrigatório, cadeia de caracteres	Nome do pool de computação na conta em que o serviço será executado.
spec obrigatório, objeto	Especificação de serviço. Consulte a tabela de especificações de serviço para mais detalhes.
external_access_integrations opcional, lista de cadeia de caracteres	Nomes das integrações de acesso externo que permitem que seu serviço acesse sites externos.
auto_resume opcional, booleano	Se deve retomar automaticamente um serviço quando uma função de serviço ou entrada é chamada.
min_instances opcional, inteiro	Número mínimo de instâncias de serviço a serem executadas.
max_instances opcional, inteiro	Número máximo de instâncias de serviço a serem executadas.
query_warehouse opcional, cadeia de caracteres	Warehouse a ser usado se um contêiner de serviço se conectar ao Snowflake para executar uma consulta, mas não especificar explicitamente um warehouse a ser usado.
comment opcional, cadeia de caracteres	Comentário para o serviço.

Atributos de especificação de serviço

Atributos de especificação de serviço¶
Atributo	Descrição
spec_type obrigatório, cadeia de caracteres	Tipo de especificação do serviço. Os valores possíveis incluem `from_file` ou `from_inline`.
spec_text obrigatório, cadeia de caracteres	(Válido somente para `spec_type="from_inline"`) Especificação de serviço. É possível usar um par de cifrões ($$) para delimitar o início e o fim da cadeia de caracteres de especificação.
stage obrigatório, cadeia de caracteres	(Válido somente para `spec_type="from_inline"`) Estágio interno Snowflake onde o arquivo de especificação é armazenado, como `@tutorial_stage`.
nome obrigatório, cadeia de caracteres	(Válido somente para `spec_type="from_inline"`) Caminho para o arquivo de especificação de serviço no estágio, como `some-dir/echo_spec.yaml`.

Atributos do objeto de tabela¶

Atributos da tabela¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake. O nome deve ser exclusivo para o esquema no qual a tabela é criada.
kind opcional, cadeia de caracteres	Tipo de tabela. Os valores possíveis incluem: TABLE para tabelas permanentes, TEMPORARY e TRANSIENT.
comment opcional, cadeia de caracteres	Descrição da tabela.
cluster_by[] opcional, lista de cadeia de caracteres	Lista de uma ou mais colunas ou expressões de coluna na tabela como a chave de clustering.
enable_schema_evolution opcional, booleano	Habilita ou desabilita a evolução do esquema para a tabela.
change_tracking opcional, booleano	Habilitar ou desabilita o rastreamento de alterações para a tabela.
data_retention_time_in_days opcional, inteiro	período de retenção, em dias, para a tabela, para que as ações Time Travel SELECT, CLONE e UNDROP possam ser executadas em dados históricos na tabela.
max_data_extension_time_in_days opcional, inteiro	Número máximo de dias que o Snowflake pode estender o período de retenção de dados para evitar que os fluxos na tabela fiquem obsoletos.
default_ddl_collation opcional, cadeia de caracteres	Especificação de agrupamento padrão para as colunas na tabela, incluindo colunas adicionadas à tabela no futuro.
columns obrigatório, lista de colunas	Lista de definições de coluna. Veja Atributos de definição de coluna.
constraints opcional, lista de restrições	Lista de definições de restrição. Consulte Atributos de definição de restrição.

Atributos de definição de coluna

Atributos de definição de coluna¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Nome da coluna.
datatype obrigatório, cadeia de caracteres	Tipo de dados contidos na coluna.
nullable opcional, booleano	Se a coluna permite valores NULL.
collate opcional, cadeia de caracteres	Agrupamento a ser usado em operações de coluna, como comparação de cadeia de caracteres.
padrão opcional, cadeia de caracteres	Se deve inserir automaticamente um valor padrão na coluna caso um valor não seja especificado explicitamente com uma instrução INSERT ou CREATE TABLE AS SELECT.
autoincrement opcional, booleano	Se deve incrementar e incluir automaticamente o número em colunas sucessivas.
autoincrement_start opcional, inteiro	Valor inicial para a coluna.
autoincrement_increment opcional, inteiro	Incremento para determinar o próximo número com incremento automático.
comment opcional, cadeia de caracteres	Descrição da coluna.

Atributos de definição de restrição

Atributos de definição de restrição¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Nome da restrição.
column_names obrigatório, lista de cadeias de caracteres	Nomes das colunas para aplicar a restrição.
constraint_type obrigatório, cadeia de caracteres	Tipo de restrição. Os valores possíveis incluem UNIQUE, PRIMARY KEY e FOREIGN KEY.
referenced_table_name obrigatório, cadeia de caracteres	(Válido somente para `constraint_type="FOREIGN KEY"`) Nome da tabela referenciada pela chave estrangeira
referenced_column_names opcional, cadeia de caracteres	(Válido somente para `constraint_type="FOREIGN KEY"`) Nomes de colunas referenciadas por chave estrangeira

Atributos da tarefa¶

Atributos da tarefa¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
definition obrigatório, cadeia de caracteres	Definição SQL para a tarefa. Pode ser uma única instrução SQL, uma chamada para um procedimento armazenado ou lógica processual usando Snowflake Scripting.
warehouse opcional, cadeia de caracteres	Warehouse virtual que fornece recursos de computação para execuções de tarefa.
schedule opcional, cadeia de caracteres	Agende a execução periódica da tarefa. Consulta Atributos do cronograma de tarefas para obter detalhes.
comment opcional, cadeia de caracteres	Descrição de comentário da tarefa.
predecessors opcional, lista de cadeia de caracteres	Uma ou mais tarefas predecessoras da tarefa atual.
user_task_managed_initial_warehouse_size opcional, cadeia de caracteres	Tamanho dos recursos de computação a serem provisionados para a primeira execução da tarefa.
user_task_timeout_ms opcional, cadeia de caracteres	Limite de tempo, em milissegundos, em uma única execução da tarefa antes que o tempo limite seja atingido.
suspend_task_after_num_failures opcional, inteiro	Número de execuções consecutivas de tarefa com falha após as quais a tarefa atual é suspensa automaticamente.
condition opcional, cadeia de caracteres	Condição de expressão SQL booliana; várias condições unidas com AND/OR são compatíveis.
allow_overlapping_execution opcional, booleano	Se deve permitir que várias instâncias do DAG sejam executadas simultaneamente.

Atributos do cronograma de tarefas

Atributos do cronograma de tarefas¶
Atributo	Descrição
schedule_type opcional, cadeia de caracteres	Tipo de cronograma. Os valores possíveis incluem `CRON_TYPE` ou `MINUTES_TYPE`.
cron_expr opcional, cadeia de caracteres	(Válido somente para `schedule_type="CRON_TYPE"`) Uma expressão cron para a execução da tarefa, como `“* * * * ? *”`.
timezone opcional, cadeia de caracteres	(Válido somente para `schedule_type="CRON_TYPE"`) Fuso horário para o cronograma, por exemplo `"america/los_angeles"`.
minutes opcional, cadeia de caracteres	(Válido somente para `schedule_type="MINUTES_TYPE"`) Número de minutos entre cada execução de tarefa.

Atributos do warehouse¶

Atributos do warehouse¶
Atributo	Descrição
nome obrigatório, cadeia de caracteres	Identificador de objeto Snowflake.
comment opcional, cadeia de caracteres	Descrição do warehouse.
warehouse_type opcional, cadeia de caracteres	Tipo de warehouse. Os valores possíveis incluem STANDARD e SNOWPARK-OPTIMIZED.
warehouse_size opcional, cadeia de caracteres	Tamanho do warehouse. Os valores possíveis incluem: XSMALL, SMALL, MEDIUM, LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE e X6LARGE.
auto_suspend opcional, cadeia de caracteres	Tempo, em segundos, antes que o warehouse seja suspenso automaticamente.
auto_resume opcional, cadeia de caracteres	Se deve retomar automaticamente um warehouse quando uma instrução SQL é enviada a ele. Os valores possíveis incluem: “true” e “false”.
max_concurrency_level opcional, inteiro	Nível de simultaneidade para instruções SQL executadas por um cluster de warehouse.
statement_queued_timeout_in_seconds opcional, inteiro	Tempo, em segundos, que uma instrução SQL pode ser enfileirada em um warehouse antes de ser cancelada pelo sistema.
statement_timeout_in_seconds opcional, inteiro	Tempo, em segundos, após o qual uma instrução SQL em execução é cancelada pelo sistema.
resource_monitor opcional, cadeia de caracteres	Nome de um monitor de recursos explicitamente atribuído ao warehouse. Quando um monitor de recursos é explicitamente atribuído a um warehouse, o monitor controla os créditos mensais usados pelo warehouse.

Exemplos¶

Crie um objeto de banco de dados usando o parâmetro option-attributes:

snow object create database name=my_db comment='Created with Snowflake CLI'

Copy

Crie um objeto de tabela usando o parâmetro option-attributes

snow object create table name=my_table columns='[{"name":"col1","datatype":"number", "nullable":false}]' constraints='[{"name":"prim_key", "column_names":["col1"], "constraint_type":"PRIMARY KEY"}]' --database my_db

Copy

Crie um banco de dados usando a opção --json object-definition:

snow object create database --json '{"name":"my_db", "comment":"Created with Snowflake CLI"}'

Copy

Crie uma tabela usando a opção --json object-definition:

snow object create table --json "$(cat table.json)" --database my_db

Copy

onde table.json contém o seguinte:

{
  "name": "my_table",
  "columns": [
    {
      "name": "col1",
      "datatype": "number",
      "nullable": false
    }
  ],
  "constraints": [
    {
      "name": "prim_key",
      "column_names": ["col1"],
      "constraint_type": "PRIMARY KEY"
    }
  ]
}

Copy