ALTER NOTEBOOK¶

Syntaxe¶

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>' ]

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 forme db_name.schema_name.object_name ou schema_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.

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 :

VERSION = 'version_alias_name'

Alias de version spécifié par l’utilisateur. Identificateur partageant le même espace de noms que l’identificateur de nom de version automatiquement généré. Il doit respecter les règles suivantes :

• Unique pour le notebook dans lequel la version est créée.

• Ne pas être défini sur FIRST, sur LAST, sur LIVE ni sur DEFAULT. Il s’agit de mots-clés réservés.

• Ne pas commencer par version$. Les noms de version automatiquement générés commencent par version$.

• Ne pas contenir de barres obliques.

Vous trouverez ci-dessous des exemples de noms d’alias de version valides.

• 1.0.0

• prod-1.1.0

COMMENT = 'string_literal'

Définit un commentaire pour le notebook ou la version du notebook.

DEFAULT_VERSION = 'version_name'

Définit la version par défaut du notebook. Le nom de version est un identificateur.

Par défaut : LAST

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.

ADD LIVE VERSION

Ajoute une version LIVE au notebook (la version qui est invoquée pour EXECUTE NOTEBOOK).

FROM LAST

Remplace la version LIVE par la version LAST du notebook.

COMMENT = 'string_literal''

Définit un commentaire pour le notebook ou la version du notebook.

COMMIT

Si une connexion Git est configurée pour le notebook, valide la version LIVE du notebook dans le référentiel Git.

Si aucun référentiel Git n’est configuré pour le notebook, l’exécution de cette commande définit la version LIVE sur null et incrémente l’alias de version automatiquement généré.

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette commande SQL doit avoir les privilèges suivants définis au minimum ainsi :

Notez que l’exploitation d’un objet dans un schéma requiert également le privilège USAGE sur la base de données et le schéma parents.

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 notebook_v2;

L’exemple suivant annule la définition de la propriété QUERY_WAREHOUSE :

ALTER NOTEBOOK my_notebook UNSET QUERY_WAREHOUSE;

L’exemple suivant définit la version LAST actuelle de my_notebook sur la version LIVE :

ALTER notebook my_notebook ADD LIVE VERSION FROM LAST;

L’exemple suivant valide la version LIVE actuelle de my_notebook :

ALTER NOTEBOOK my_notebook COMMIT;