ALTER NOTEBOOK¶
Modifica as propriedades de um notebook existente.
Sintaxe¶
ALTER NOTEBOOK [ IF EXISTS ] <name> RENAME TO <new_name>
ALTER NOTEBOOK [ IF EXISTS ] <name> SET
[ COMMENT = '<string_literal>' ]
[ QUERY_WAREHOUSE = <warehouse_to_run_nb_and_sql_queries_in> ]
[ IDLE_AUTO_SHUTDOWN_TIME_SECONDS = <number_of_seconds> ]
[ SECRETS = ('<secret_variable_name>' = <secret_name>) [ , ... ] ]
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áriodb_name.schema_name.object_name
ouschema_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.
Você não pode usar o parâmetro RENAME TO para mover um notebook privado para um banco de dados diferente. Se quiser mover o notebook para outro banco de dados para disponibilizá-lo a outras pessoas (por exemplo, para uso compartilhado), crie um novo notebook em um banco de dados diferente, usando o notebook privado como modelo. Consulte Como disponibilizar um notebook privado para uso geral.
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:
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.
Requisitos de controle de acesso¶
A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:
Privilégio |
Objeto |
Notas |
---|---|---|
USAGE ou OWNERSHIP |
Notebook |
OWNERSHIP é um privilégio especial em um objeto concedido automaticamente à função que criou o objeto. |
O privilégio USAGE no banco de dados e no esquema pai é necessário para executar operações em qualquer objeto de um esquema.
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 TO notebook_v2;
O exemplo a seguir desativa a propriedade QUERY_WAREHOUSE:
ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;