CREATE NOTEBOOK PROJECT

Crée un objet de projet de notebook. Un projet de notebook (NPO). Vous pouvez créer un objet de projet de notebook à partir d’une zone de préparation ou d’un espace de travail privé.

Note

La création d’objets de projet de notebook à partir d’espaces de travail partagés n’est pas prise en charge actuellement.

Voir aussi :

EXECUTE NOTEBOOK PROJECT, SHOW NOTEBOOK PROJECTS, CREATE NOTEBOOK, EXECUTE NOTEBOOK

Syntaxe

Créer un objet de projet de notebook à partir d’un espace de travail privé :

CREATE NOTEBOOK PROJECT <database_name>.<schema_name>.<project_name>
  FROM 'snow://workspace/<workspace_path>'
  [ COMMENT = '<string_literal>' ];
Copy

Créer un objet de projet de notebook à partir d’une zone de préparation :

CREATE NOTEBOOK PROJECT [ IF NOT EXISTS ] <database_name>.<schema_name>.<project_name>
  FROM '@<database_name>.<schema_name>.<stage_name>'
  [ COMMENT = '<string_literal>' ];
Copy

Paramètres requis

database_name.schema_name.project_name

Identificateur pleinement qualifié du projet de notebook.

Le nom du projet doit être unique au sein du schéma.

Les identificateurs doivent commencer par un caractère alphabétique et ne peuvent pas contenir d’espaces ou de caractères spéciaux, sauf si l’identificateur est mis entre guillemets doubles (par exemple, "My Project").

Les identificateurs entre guillemets doubles sont sensibles à la casse.

FROM 'snow://workspace/{workspace_path' | '@database_name.schema_name.stage_name' }

Spécifie la source qui soutient ce projet de notebook.

  • Utilisez une snow://workspace/... URL pour créer le projet de notebook à partir d’une version de l’espace de travail dans Snowsight.

  • Utilisez une référence de zone de préparation (par exemple, '@my_db.my_schema.my_stage') pour créer le projet de notebook à partir des fichiers de notebook que vous avez déployés dans une zone de préparation interne ou temporaire.

Lors de la création à partir d’un espace de travail, la valeur doit être une snow://workspace/... URL pointant vers une version d’espace de travail.

Le chemin d’accès comprend généralement :

  • USER$ ou un autre propriétaire.

  • Schéma :

  • Nom de l’espace de travail.

  • Version (for example, versions/last).

Par exemple :

  • snow://workspace/USER$.MY_SCHEMA."my_notebook_workspace"/versions/last

Pour localiser le chemin d’accès de l’espace de travail, exécutez la commande suivante :

LIST 'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/last/';
Copy

Paramètres facultatifs

COMMENT = 'string_literal'

Ajoute un commentaire ou une description à l’objet de projet de notebook.

Utilisez des commentaires pour décrire l’objectif ou le workflow (par exemple, COMMENT = 'Notebook project for this workflow').

Les commentaires sont stockés sous forme de métadonnées d’objets. Évitez d’inclure des données sensibles dans les commentaires.

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

Pour exécuter CREATE NOTEBOOK PROJECT, un rôle doit disposer de privilèges suffisants pour créer des objets dans la base de données et le schéma cibles. Les privilèges requis sont les suivants :

  • USAGE ou OWNERSHIP sur la base de données.

  • USAGE ou OWNERSHIP sur le schéma.

  • CREATE NOTEBOOK PROJECT sur le schéma qui permet de créer des objets dans ce 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

  • Les clauses OR REPLACE et IF NOT EXISTS s’excluent mutuellement. Elles ne peuvent pas être utilisées dans la même instruction.

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

  • A notebook project points to the specified workspace version indicated in the FROM clause. Using versions/last always references the latest workspace version; using a fixed path references a static version.

  • Si vous créez le projet de notebook à partir d’une zone de préparation, vous pouvez le mettre à jour en ajoutant des versions de la zone de préparation. Pour plus de détails, voir Exécuter et planifier des notebooks dans Workspaces.

  • Utilisez des noms de projets descriptifs pour simplifier l’orchestration des workflows.

  • Le remplacement d’un projet met à jour le chemin d’accès et les métadonnées de l’espace de travail stocké.

  • Pour exécuter la commande CREATE NOTEBOOK PROJECT, vous devez l’exécuter à partir d’un fichier SQL ou d’une feuille de calcul SQL dans les espaces de travail, et non depuis une cellule de notebook.

Exemples

Créer un projet de notebook pour un espace de travail :

CREATE NOTEBOOK PROJECT analytics_db.workflow_schema.workflow_proj
  FROM 'snow://workspace/USER$.workflow_schema."etl_workflow"/versions/last'
  COMMENT = 'Notebook project for nightly ETL workflow';
Copy

Créer un projet de notebook à partir d’une zone de préparation :

CREATE NOTEBOOK PROJECT analytics_db.workflow_schema.workflow_proj
  FROM '@NOTEBOOK_PROJECT_STAGE'
  COMMENT = 'Notebook project created from an internal or temporary stage';
Copy

Créer un projet de notebook à partir d’une zone de préparation à l’aide de IF NOT EXISTS :

CREATE NOTEBOOK PROJECT IF NOT EXISTS ML_TRAIN_NOTEBOOK3
  FROM '@NOTEBOOK_PROJECT_STAGE1'
  COMMENT = 'Notebook project created from an internal or temporary stage';
Copy