CREATE NOTEBOOK¶

Syntaxe¶

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

Paramètres requis¶

name

Chaîne qui spécifie l’identificateur (c’est-à-dire le nom) du notebook ; doit être unique pour le schéma dans lequel le notebook est créé.

De plus, l’identificateur doit commencer par un caractère alphabétique et ne peut pas contenir d’espaces ou de caractères spéciaux à moins que toute la chaîne d’identificateur soit délimitée par des guillemets doubles (par exemple, "My object"). Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Pour plus d’informations, voir Exigences relatives à l’identificateur.

Paramètres facultatifs¶

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 LASTni 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.

Voici des exemples de noms d’alias de version valides :

• 1.0.0

• prod-1.1.0

FROM 'source_location

Emplacement à partir duquel copier le fichier. Il doit s’agir d’un emplacement de zone de préparation Snowflake.

Si cela est spécifié, un objet notebook est créé en fonction du fichier copié. Si cela n’est pas spécifié, l’objet de notebook est créé à partir d’un modèle de notebook.

Si cela est spécifié, le paramètre MAIN_FILE doit être défini sur le nom du fichier à copier. Ce fichier doit être un fichier ipynb.

MAIN_FILE = 'main_file_name'

Identificateur spécifié par l’utilisateur pour le nom de fichier de notebook. Cela est différent du nom d’objet de notebook, qui est spécifié dans le paramètre name. Ce fichier doit être un fichier ipynb.

COMMENT = 'string_literal'

Spécifie un commentaire pour le notebook ou la version du notebook.

Par défaut : aucune valeur

DEFAULT_VERSION = 'version_name'

Définit la version par défaut du notebook (la version qui est invoquée pour EXECUTE 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.

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.

• Les instructions CREATE OR REPLACE <objet> sont atomiques. En d’autres termes, lorsqu’un objet est remplacé, l’ancien objet est supprimé et le nouvel objet est créé dans une seule transaction.

Exemples¶

La procédure suivante crée un notebook nommé mynotebook :

CREATE NOTEBOOK mynotebook;

Bien que le paramètre QUERY_WAREHOUSE soit facultatif, il est recommandé de le spécifier lors de la création d’un nouveau notebook afin de pouvoir appliquer EXECUTE NOTEBOOK au notebook.

CREATE NOTEBOOK mynotebook
 QUERY_WAREHOUSE = my_warehouse;

L’exemple suivant crée un notebook à partir d’un fichier ipynb dans une zone de préparation :

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