CREATE NOTEBOOK¶

Sintaxe¶

CREATE [ OR REPLACE ] NOTEBOOK [ IF NOT EXISTS ] <name>
  [ VERSION '<version_alias_name>' ]
  [ FROM '<source_location>' ]
  [ MAIN_FILE = '<main_file_name>' ]
  [ COMMENT = '<string_literal>' ]
  [ DEFAULT_VERSION = '<version_name>' ]
  [ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
  [ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]

Parâmetros obrigatórios¶

name

Cadeia de caracteres que especifica o identificador (ou seja, nome) do notebook; deve ser único para o esquema no qual o notebook é criado.

Além disso, o identificador deve começar com um caractere alfabético e não pode conter espaços ou caracteres especiais, a menos que toda a cadeia de caracteres do identificador esteja entre aspas duplas (por exemplo, "My object"). Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

Parâmetros opcionais¶

VERSION 'version_alias_name'

Alias da versão especificada pelo usuário. Um identificador compartilhando o mesmo namespace com o identificador de nome de versão gerado automaticamente. Ele deve seguir estas regras:

• Exclusivo para o notebook no qual a versão é criada.

• Não é definido como FIRST, LAST ou DEFAULT. Estas são palavras-chave reservadas.

• Não começa com version$. Os nomes das versões geradas automaticamente começam com version$.

• Não contém barras.

A seguir estão alguns exemplos de nomes de alias de versão válidos:

• 1.0.0

• prod-1.1.0

FROM 'source_location

Local de onde copiar o arquivo. Este deve ser um local de estágio do Snowflake.

Se especificado, um objeto de notebook é criado com base no arquivo copiado. Se não for especificado, o objeto de notebook será criado a partir de um notebook de modelo.

Se especificado, o parâmetro MAIN_FILE deve ser definido como o nome do arquivo que você deseja copiar. Este arquivo deve ser um arquivo ipynb.

MAIN_FILE = 'main_file_name'

Identificador especificado pelo usuário para o nome do arquivo do notebook. Isso é separado do nome do objeto do notebook, que é especificado no parâmetro name. Este arquivo deve ser um arquivo ipynb.

COMMENT = 'string_literal'

Especifica um comentário para o notebook ou versão do notebook.

Padrão: sem valor

DEFAULT_VERSION = 'version_name'

Define a versão padrão do notebook (a versão que é invocada para EXECUTE NOTEBOOK). O nome da versão é um identificador.

Padrão: LAST

QUERY_WAREHOUSE = warehouse_name

Especifica o warehouse em que as consultas SQL no notebook são executadas. Este parâmetro é opcional. No entanto, é necessário executar o comando EXECUTE NOTEBOOK.

IDLE_AUTO_SHUTDOWN_TIME_SECONDS = number_of_seconds

Número de segundos de tempo ocioso antes que o notebook seja desligado automaticamente. Este parâmetro só está disponível para notebooks em execução no tempo de execução do contêiner. O valor deve ser um inteiro entre 60 e 259200 (72 horas).

Padrão: 3600 segundos

Requisitos de controle de acesso¶

Uma função usada para executar este comando SQL deve ter os seguintes privilégios no mínimo:

Observe que operar em qualquer objeto de um esquema também requer o privilégio USAGE no banco de dados e esquema principais.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

• Em relação aos metadados:

  Atenção

  Os clientes devem garantir que nenhum dado pessoal (exceto para um objeto do usuário), dados sensíveis, dados controlados por exportação ou outros dados regulamentados sejam inseridos como metadados ao usar o serviço Snowflake. Para obter mais informações, consulte Campos de metadados no Snowflake.

• Instruções CREATE OR REPLACE <object> são atômicas. Ou seja, quando um objeto é substituído, o objeto antigo é excluído e o novo objeto é criado em uma única transação.

Exemplos¶

O seguinte cria um notebook chamado mynotebook:

CREATE NOTEBOOK mynotebook;

Embora o parâmetro QUERY_WAREHOUSE seja opcional, especificá-lo é recomendado ao criar um novo notebook para que EXECUTE NOTEBOOK possa ser executado no notebook.

CREATE NOTEBOOK mynotebook
 QUERY_WAREHOUSE = my_warehouse;

O exemplo a seguir cria um notebook a partir de um arquivo ipynb em um estágio:

CREATE NOTEBOOK mynotebook
 FROM '@my_db.my_schema.my_stage'
 MAIN_FILE = 'my_notebook_file.ipynb'
 QUERY_WAREHOUSE = my_warehouse;