Configuração comum para tutoriais das APIs Snowflake Python¶

Introdução¶

Este tópico fornece instruções para a configuração comum necessária para todos os tutoriais do Snowflake Python APIs disponíveis nesta documentação.

from snowflake.snowpark import Session
from snowflake.core import Root

session = Session.builder.configs(connection_params).create()
root = Root(session)

Instale o Snowflake Python APIs¶

Antes de instalar a API, você precisa ativar um ambiente Python.

Neste tutorial, você pode usar conda ou um ambiente virtual (venv).

1. Para criar e ativar um ambiente conda ou virtual, abra um terminal de linha de comando e execute os seguintes comandos:

   condavenv

   conda create -n <env_name> python==3.10
   conda activate <env_name>
   

   Copy

2. O pacote Snowflake Python APIs está disponível em PyPI.

   Para instalar o pacote da API no novo ambiente conda ou virtual, execute o seguinte comando:

   pip install snowflake -U
   

   Copy

Configure seu ambiente de desenvolvimento¶

Este tutorial aborda exemplos de código que você pode executar em um notebook Jupyter. Cada etapa do tutorial demonstra incrementalmente os recursos do Snowflake Python APIs.

Comece configurando seu ambiente de desenvolvimento para poder executar os exemplos de código em um notebook.

1. Crie um arquivo nomeado $HOME/.snowflake/connections.toml com os seguintes parâmetros de conexão e atualize-o com suas credenciais reais:

   [default]
   account = "<YOUR ACCOUNT NAME>"
   user = "<YOUR ACCOUNT USER>"
   password = "<YOUR ACCOUNT USER PASSWORD>"
   # optional
   # warehouse = "<YOUR COMPUTE WH>"
   # optional
   # database = "<YOUR DATABASE>"
   # optional
   # schema = "<YOUR SCHEMA>"
   

   Copy

   Nota

   O parâmetro account não oferece suporte a identificadores de conta com sublinhados. Você deve especificar um identificador de conta com traços no lugar de sublinhados. Para obter mais informações, consulte Nome da conta na sua organização.

   Este exemplo especifica esses parâmetros como a conexão padrão com o Snowflake em seu ambiente, criando uma definição de conexão chamada default.

2. Use um dos seguintes métodos para abrir um notebook:

   • Abra um novo notebook em um editor de código compatível com notebooks Jupyter (como o Visual Studio Code).

   • Para abrir um notebook em seu navegador, inicie um servidor de notebook com o comando jupyter notebook.

     Para garantir que seu ambiente possa executar um notebook, execute conda install notebook em seu terminal antes de iniciar o servidor do notebook.

3. Na primeira célula do notebook, execute as seguintes instruções de importação:

   from datetime import timedelta
   
   from snowflake.snowpark import Session
   from snowflake.snowpark.functions import col
   from snowflake.core import Root, CreateMode
   from snowflake.core.database import Database
   from snowflake.core.schema import Schema
   from snowflake.core.stage import Stage
   from snowflake.core.table import Table, TableColumn, PrimaryKey
   from snowflake.core.task import StoredProcedureCall, Task
   from snowflake.core.task.dagv1 import DAGOperation, DAG, DAGTask
   from snowflake.core.warehouse import Warehouse
   

   Copy

   Nota

   Após executar esta célula, você pode ser solicitado a definir seu kernel Python. Se você ativou um ambiente conda, selecione conda como o kernel Python (por exemplo, algo semelhante a: ~/miniconda3/envs/<seu ambiente conda>/bin/python).

   Nesta célula, você importa o Snowpark e as APIs principais que gerenciam os objetos Snowflake.

4. Na próxima célula, execute o seguinte código:

   connection_params = {
       "connection_name": "default"
   }
   

   Copy

   Nesta célula, você define os parâmetros de conexão do Snowflake para sua sessão criando um dicionário connection_params especificando a definição de conexão nomeada default que você configurou anteriormente.

5. Para estabelecer uma conexão com o Snowflake, crie uma sessão Snowpark e passe connection_params como argumento:

   session = Session.builder.configs(connection_params).create()
   

   Copy

6. Para criar um objeto Root, passe seu objeto session ao construtor Root:

   root = Root(session)
   

   Copy

E é isso! Ao executar o código nessas quatro células, você estará pronto para usar o Snowflake Python APIs.