ALTER NOTEBOOK¶
Modifie les propriétés d’un notebook existant.
Syntaxe¶
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>) [ , ... ] ]
Paramètres¶
name
Spécifie l’identificateur du notebook à modifier.
Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.
Pour plus d’informations, voir Exigences relatives à l’identificateur.
RENAME TO new_name
Remplace le nom du notebook par
new_name
. Le nouvel identificateur doit être unique pour le schéma.Pour plus de détails sur les identificateurs, voir Exigences relatives à l’identificateur.
Vous pouvez déplacer l’objet vers une autre base de données et/ou un autre schéma tout en renommant éventuellement l’objet. Pour ce faire, spécifiez une valeur
new_name
qualifiée qui inclut le nouveau nom de la base de données et/ou du schéma sous la formedb_name.schema_name.object_name
ouschema_name.object_name
, respectivement.Note
La base de données et/ou le schéma de destination doivent déjà exister. En outre, un objet portant le même nom ne peut pas déjà exister dans le nouvel emplacement ; sinon, l’instruction renvoie une erreur.
Le déplacement d’un objet vers un schéma d’accès géré est interdit sauf si le propriétaire de l’objet (c’est-à-dire le rôle qui a le privilège OWNERSHIP sur l’objet) est également propriétaire du schéma cible.
Vous ne pouvez pas utiliser le paramètre RENAME TO pour déplacer un carnet privé vers une autre base de données. Si vous souhaitez déplacer votre carnet vers une autre base de données afin de le rendre disponible à d’autres personnes (par exemple, pour une utilisation partagée), créez un nouveau carnet dans une autre base de données, en utilisant votre carnet privé comme modèle. Voir Rendre un notebook privé disponible pour usage général.
Lorsqu’un objet est renommé, les autres objets qui le référencent doivent être mis à jour avec le nouveau nom.
SET ...
Définit un(e) ou plusieurs propriétés ou paramètres spécifiés pour le notebook :
QUERY_WAREHOUSE = warehouse_name
Spécifie l’entrepôt dans lequel sont exécutées les requêtes SQL dans le notebook. Ce paramètre est facultatif. Cependant, il est nécessaire d’exécuter la commande EXECUTE NOTEBOOK.
IDLE_AUTO_SHUTDOWN_TIME_SECONDS = number_of_seconds
Nombre de secondes d’inactivité avant l’arrêt automatique du carnet. Ce paramètre n’est disponible que pour les carnets exécutés sur l’environnement Container Runtime. La valeur doit être un entier compris entre 60 et 259200 (72 heures).
La valeur par défaut est 3 600 secondes.
SECRETS = '(secret_variable_name' = secret_name [ , ... ])
Définit des variables secrètes pour le carnet.
secret_variable_name
- La variable qui sera utilisée dans la cellule du carnet lors de la récupération des informations du secret.secret_name
- Nom du secret Snowflake.
UNSET ...
Annule la définition d’un(e) ou de plusieurs propriétés ou paramètres spécifiés pour le notebook, ce qui rétablit les propriétés aux valeurs par défaut :
QUERY_WAREHOUSE
COMMENT
Pour désactiver plusieurs propriétés ou paramètres via une seule instruction ALTER, séparez chaque propriété ou paramètre par une virgule.
Lorsque vous désactivez une propriété ou un paramètre, spécifiez uniquement le nom de propriété ou de paramètre (sauf si la syntaxe ci-dessus indique que vous devez spécifier la valeur). La spécification de la valeur renvoie une erreur.
Exigences en matière de contrôle d’accès¶
Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :
Privilège |
Objet |
Remarques |
---|---|---|
USAGE ou OWNERSHIP |
Notebook |
OWNERSHIP est un privilège spécial sur un objet qui est automatiquement accordé au rôle qui a créé l’objet. |
Le privilège USAGE relatif à la base de données et au schéma parents est exigé pour effectuer des opérations sur tout objet d’un schéma.
Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.
Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.
Notes sur l’utilisation¶
Concernant les métadonnées :
Attention
Les clients doivent s’assurer qu’aucune donnée personnelle (autre que pour un objet utilisateur), donnée sensible, donnée à exportation contrôlée ou autre donnée réglementée n’est saisie comme métadonnée lors de l’utilisation du service Snowflake. Pour plus d’informations, voir Champs de métadonnées dans Snowflake.
Exemples¶
L’exemple suivant remplace le nom du notebook nommé my_notebook
par notebook_v2
:
ALTER NOTEBOOK my_notebook RENAME TO notebook_v2;
L’exemple suivant annule la définition de la propriété QUERY_WAREHOUSE :
ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;