ALTER NOTEBOOK¶

Sintaxe¶

ALTER NOTEBOOK [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER NOTEBOOK [ IF EXISTS ] <name> SET
  [ VERSION = '<version_alias_name>' ]
  [ COMMENT = '<string_literal>' ]
  [ DEFAULT_VERSION = '<default_version_name_or_alias>' ]
  [ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
  [ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]
  [ SECRETS = ('<secret_variable_name>' = <secret_name>) [ , ... ] ]

ALTER NOTEBOOK [ IF EXISTS ] <name> UNSET
  [ QUERY_WAREHOUSE ]
  [ COMMENT ]

ALTER NOTEBOOK <name> ADD LIVE VERSION
  [ FROM LAST ]
  [ COMMENT = '<string_literal>' ]

ALTER NOTEBOOK <name> COMMIT [ VERSION '<live_version_alias>' ] [ COMMENT = '<string_literal>' ]

Parâmetros¶

name

Especifica o identificador do notebook a ser alterado.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

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

RENAME TO new_name

Altera o nome do notebook para new_name. O novo identificador deve ser único para o esquema.

Para obter mais detalhes sobre os identificadores de, consulte Requisitos para identificadores.

Você pode mover o objeto para um banco de dados e/ou esquema diferente enquanto opcionalmente renomeia o objeto. Para isso, especifique um valor qualificado new_name que inclua o novo banco de dados e/ou nome do esquema no formulário db_name.schema_name.object_name ou schema_name.object_name, respectivamente.

Nota

• O banco de dados e/ou esquema de destino já deve existir. Além disso, um objeto com o mesmo nome não pode já existir no banco de dados de destino; caso contrário, a instrução retorna um erro.

• É proibido mover um objeto para um esquema de acesso gerenciado a menos que o proprietário do objeto (ou seja, a função que tem o privilégio OWNERSHIP sobre o objeto) também possua o esquema de destino.

Quando um objeto é renomeado, outros objetos que fazem referência a ele devem ser atualizados com o novo nome.

SET ...

Define uma ou mais propriedades ou parâmetros especificados para o notebook:

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, LIVE 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 exemplos de nomes de alias de versão válidos.

• 1.0.0

• prod-1.1.0

COMMENT = 'string_literal'

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

DEFAULT_VERSION = 'version_name'

Define a versão padrão do 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

SECRETS = '(secret_variable_name' = secret_name [ , ... ])

Define variáveis de segredo para o notebook.

• secret_variable_name – A variável que será usada na célula do notebook ao recuperar informações do segredo.

• secret_name – O nome do segredo Snowflake.

UNSET ...

Desmarca uma ou mais propriedades ou parâmetros especificados para o notebook, o que redefine as propriedades para os padrões:

• QUERY_WAREHOUSE

• COMMENT

Para desmarcar várias propriedades ou parâmetros com uma única instrução ALTER, separe cada propriedade ou parâmetro com uma vírgula.

Ao desmarcar uma propriedade ou parâmetro, especifique apenas o nome da propriedade ou parâmetro (a menos que a sintaxe acima indique que você deve especificar o valor). Especificar o valor retorna um erro.

ADD LIVE VERSION

Adiciona uma versão LIVE para o notebook (a versão que é invocada para EXECUTE NOTEBOOK).

FROM LAST

Define a versão LIVE como a versão LAST do notebook.

COMMENT = 'string_literal''

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

COMMIT

Se uma conexão Git for configurada para o notebook, confirma a versão LIVE do notebook para o repositório Git.

Se nenhum repositório Git estiver configurado para o notebook, executar este comando definirá a versão LIVE como null e incrementará o alias da versão gerada automaticamente.

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.

Exemplos¶

O exemplo a seguir renomeia o notebook chamado my_notebook para notebook_v2:

ALTER NOTEBOOK my_notebook RENAME notebook_v2;

O exemplo a seguir desativa a propriedade QUERY_WAREHOUSE:

ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;

O exemplo a seguir define a versão LAST atual do my_notebook como a versão LIVE:

ALTER notebook my_notebook ADD LIVE VERSION FROM LAST;

O exemplo a seguir confirma a versão LIVE atual do my_notebook:

ALTER NOTEBOOK my_notebook COMMIT;