CREATE NOTEBOOK PROJECT

Cria um novo projeto de notebook ou substitui um existente. Um objeto de projeto de notebook vincula um espaço de trabalho do Snowsight (identificado pelo URL snow://workspace/...) a um banco de dados e esquema, para que ele possa ser executado com EXECUTE NOTEBOOK PROJECT.

Consulte também:

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

Sintaxe

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

Parâmetros obrigatórios

database_name.schema_name.project_name

Identificador totalmente qualificado do projeto de notebook.

O nome do projeto deve ser exclusivo no esquema.

Os identificadores devem começar com um caractere alfabético e não podem conter espaços ou caracteres especiais, a menos que estejam entre aspas duplas (por exemplo, "My Project").

Os identificadores delimitados por aspas duplas diferenciam letras maiúsculas de minúsculas.

FROM 'snow://workspace/workspace_path'

Especifica o espaço de trabalho do Snowsight em que este projeto de notebook é executado.

O valor deve ser um URL snow://workspace/... que aponta para uma versão do espaço de trabalho.

Normalmente, o caminho inclui:

  • USER$ ou outro proprietário.

  • Esquema.

  • Nome do espaço de trabalho.

  • Versão (por exemplo, versions/head).

Por exemplo:

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

Para localizar o caminho do espaço de trabalho, execute o seguinte comando:

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

Parâmetros opcionais

COMMENT = 'string_literal'

Adiciona um comentário ou uma descrição ao objeto de projeto de notebook.

Use os comentários para descrever a finalidade ou o fluxo de trabalho (por exemplo, COMMENT = 'Notebook project for this workflow').

Os comentários são armazenados como metadados de objeto. Evite incluir dados sensíveis nos comentários.

Requisitos de controle de acesso

Para executar CREATE NOTEBOOK PROJECT, uma função deve ter privilégios suficientes para criar objetos no banco de dados e esquema de destino. Os privilégios exigidos incluem:

  • USAGE ou OWNERSHIP no banco de dados.

  • USAGE ou OWNERSHIP no esquema.

  • CREATE NOTEBOOK PROJECT no esquema que permite criar objetos dentro desse 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

  • As cláusulas OR REPLACE e IF NOT EXISTS são mutuamente exclusivas. Os dois não podem ser usados na mesma instrução.

  • Instruções CREATE OR REPLACE <object> são atômicas. Ou seja, quando um objeto é substituído, o objeto antigo é excluído e o novo objeto é criado em uma única transação.

  • Um projeto de notebook aponta para a versão de espaço de trabalho especificada, indicada na cláusula FROM. O uso de versions/head sempre faz referência à versão mais recente do espaço de trabalho. O uso de um caminho fixo faz referência a uma versão estática.

  • Use nomes de projetos descritivos para simplificar a orquestração do fluxo de trabalho.

  • Substituir um projeto atualiza o caminho e os metadados do espaço de trabalho armazenado.

Exemplos

Criar um projeto de notebook para um espaço de trabalho:

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