Gemeinsame Einrichtung für Snowflake Python APIs-Tutorials¶

Einführung¶

Dieses Thema enthält Anweisungen für die gemeinsame Einrichtung, die für alle in dieser Dokumentation verfügbaren Snowflake Python APIs-Tutorials erforderlich ist.

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

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

Snowflake Python APIs installieren¶

Bevor Sie API installieren, müssen Sie eine Python-Umgebung aktivieren.

In diesem Tutorial können Sie conda oder eine virtuelle Umgebung (venv) verwenden.

1. Um eine conda oder virtuelle Umgebung zu erstellen und zu aktivieren, öffnen Sie ein Terminal in der Befehlszeile und führen die folgenden Befehle aus:

   condavenv

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

   Copy

2. Das Snowflake Python APIs-Paket ist unter PyPI verfügbar.

   Um das APIPaket in der neuen conda oder virtuellen Umgebung zu installieren, führen Sie den folgenden Befehl aus:

   pip install snowflake -U
   

   Copy

Einrichten Ihrer Entwicklungsumgebung¶

Dieses Tutorial führt Sie durch Codebeispiele, die Sie in einem Jupyter-Notebook ausführen können. Jeder Schritt des Tutorials zeigt schrittweise die Möglichkeiten von Snowflake Python APIs.

Sie beginnen mit der Einstellung Ihrer Entwicklungsumgebung, damit Sie die Codebeispiele in einem Notebook ausführen können.

1. Erstellen Sie eine Datei mit dem Namen $HOME/.snowflake/connections.toml mit den folgenden Parametern für die Verbindung, und aktualisieren Sie sie mit Ihren echten Anmeldeinformationen:

   [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

   Bemerkung

   Der Parameter account unterstützt nicht Kontobezeichner mit Unterstrichen. Sie müssen einen Kontobezeichner mit Bindestrichen anstelle von Unterstrichen angeben. Weitere Informationen finden Sie unter -Kontoname in Ihrer Organisation.

   In diesem Beispiel werden diese Parameter als Standardverbindung zu Snowflake in Ihrer Umgebung festgelegt, indem eine Definition der Verbindung mit dem Namen default erstellt wird.

2. Verwenden Sie eine der folgenden Methoden, um ein Notebook zu öffnen:

   • Öffnen Sie ein neues Notebook in einem Code-Editor, der Jupyter-Notebooks unterstützt (z. B. Visual Studio Code).

   • Um ein Notebook in Ihrem Browser zu öffnen, starten Sie einen Notebook-Server mit dem Befehl jupyter notebook.

     Um sicherzustellen, dass Ihre Umgebung ein Notebook ausführen kann, führen Sie conda install notebook in Ihrem Terminal aus, bevor Sie den Notebook-Server starten.

3. Führen Sie in der ersten Zelle des Notebooks die folgenden Importanweisungen aus:

   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

   Bemerkung

   Nachdem Sie diese Zelle ausgeführt haben, werden Sie möglicherweise aufgefordert, Ihren Python-Kernel festzulegen. Wenn Sie eine conda-Umgebung aktiviert haben, wählen Sie conda als Python-Kernel aus (z. B. so etwas wie: ~/miniconda3/envs/<your conda env>/bin/python).

   In dieser Zelle importieren Sie Snowpark und die zentralen APIs, die Snowflake-Objekte verwalten.

4. Führen Sie in der nächsten Zelle den folgenden Code aus:

   connection_params = {
       "connection_name": "default"
   }
   

   Copy

   In dieser Zelle legen Sie die Snowflake-Verbindungsparameter für Ihre Sitzung fest, indem Sie ein connection_params-Dictionary erstellen, das die zuvor konfigurierte Definition der Verbindung mit dem Namen default enthält.

5. Um eine Verbindung zu Snowflake herzustellen, erstellen Sie eine Snowpark-Sitzung und übergeben connection_params als Argument:

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

   Copy

6. Um ein Root-Objekt zu erstellen, übergeben Sie Ihr session Objekt an den Root-Konstruktor:

   root = Root(session)
   

   Copy

Und das war’s! Indem Sie den Code in diesen vier Zellen ausführen, sind Sie nun bereit, die Snowflake Python APIs zu verwenden.