Vorbereiten eines lokalen Ordners mit konfigurierten Snowflake Native App-Artefakten¶

Erstellen Sie einen lokalen Ordner mit konfigurierten Artefakten¶

Der Befehl snow app bundle erstellt ein lokales Verzeichnis in Ihrem Projekt, füllt es mit der Struktur auf, die Sie in der Projektdefinitionsdatei angegeben haben, und generiert CREATE FUNCTION- oder CREATE PROCEDURE-Deklarationen in Snowflake Native Apps Setup-Skripten aus Snowpark Python-Code, der Decorators (wie @sproc oder @udaf) enthält. Weitere Informationen finden Sie in der Snowpark Python-Dokumentation zu dem von Ihnen gewählten Funktions-Decorators, z. B. snowflake.snowpark.functions.udaf.

Die Befehle snow app deploy und snow app run nutzen diese Funktionalität bereits. Mit dem expliziten Befehl snow app bundle können Sie dieses Verzeichnis nun jedoch erkunden, bevor es in den Stagingbereich hochgeladen wird, um zu überprüfen, ob die Artefakte wie erwartet erstellt wurden.

Um einen lokalen Ordner mit den konfigurierten Artefakten zu erstellen, gehen Sie wie folgt vor:

1. Erstellen oder überprüfen Sie Ihre Snowflake-snowflake.yml-Projektdefinitionsdatei, z. B.:

   definition_version: 2
   entities:
     codegen_nativeapp_pkg:
       type: application package
       manifest: root_files/_manifest.yml
       artifacts:
         - src: root_files/README.md
           dest: README.md
         - src: root_files/_manifest.yml
           dest: manifest.yml
         - src: root_files/setup_scripts/*
           dest: setup_scripts/
         - src: python/user_gen/echo.py
           dest: user_gen/echo.py
         - src: python/cli_gen/*
           dest: cli_gen/
           processors:
             - snowpark
     codegen_nativeapp_pkg:
       type: application
       from:
         target: codegen_nativeapp_pkg
   

   Copy

2. Führen Sie in Ihrem Projektverzeichnis den snow app bundle-Befehl aus, um das temporäre output/deploy-Verzeichnis zu erstellen, das Ihre konfigurierten Artefakte enthält.

   snow app bundle
   

   Copy

3. Überprüfen Sie, ob der Inhalt des Ausgabe- oder Bereitstellungsverzeichnisses den Regeln entspricht, die Sie in der snowflake.yml.-Datei angegeben haben. Wenn Sie die Snowpark-Anmerkungsverarbeitung in Ihren Python-Dateien aufgerufen haben, können Sie den generierten Code in dem geänderten Setup-Skript im Verzeichnis sehen.

Weitere Informationen finden Sie unter dem Befehl snow app bundle.

Generieren von SQL-Code mit der Snowpark-Anmerkungsverarbeitung¶

Als Snowflake Native App-Entwickler mit einem begrenzten SQL-Hintergrund finden Sie es vielleicht mühsam, Setup-Skripte zu schreiben und zu pflegen, die mit der Zeit recht umfangreich und kompliziert werden können. Setup-Skripte enthalten die gesamte Anwendungslogik, die ein Kunde mit seinen Daten verwenden kann, und sind daher ein erforderlicher Teil der Entwicklung einer Snowflake Native App. Eine der wichtigsten Komponenten von Setup-Skripten ist Ihre Möglichkeit, Snowpark Python-Erweiterungsfunktionen für Funktionen und gespeicherte Prozeduren zu verwenden. Zusätzlich zum Schreiben von Snowpark-Code in Python, Java oder anderen von Snowpark unterstützten Sprachen müssen Sie die entsprechenden Teile dieser Funktionen und Prozeduren unter SQL in das Setup-Skript schreiben.

Sie können zum Beispiel eine grundlegende Funktion und eine gespeicherte Prozedur mit Snowpark Python erstellen, wie in der Abbildung gezeigt:

# Example python file "echo.py" that a developer writes

def echo_fn(data):
    return 'echo_fn: ' + data

def echo_proc(session, data):
    return 'echo_proc: ' + data

Sie müssen dann die Datei in einen Stagingbereich hochladen und im Setup-Skript-SQL-Code darauf verweisen, ähnlich wie im Folgenden:

-- Sample setup_script.sql SQL file for a Snowflake Native App

CREATE APPLICATION ROLE IF NOT EXISTS app_instance_role;

CREATE OR ALTER VERSIONED SCHEMA ext_code_schema;
GRANT USAGE ON SCHEMA ext_code_schema TO APPLICATION ROLE app_instance_role;

CREATE OR REPLACE PROCEDURE ext_code_schema.py_echo_proc(DATA string)
  RETURNS STRING
  LANGUAGE PYTHON
  RUNTIME_VERSION = 3.9
  PACKAGES=('snowflake-snowpark-python')
  HANDLER='echo.echo_proc'
  IMPORTS=('/echo.py');

    GRANT USAGE ON PROCEDURE ext_code_schema.py_echo_proc(string)
      TO APPLICATION ROLE app_instance_role;

-- Wraps a function from a python file
CREATE OR REPLACE FUNCTION ext_code_schema.py_echo_fn(string)
RETURNS STRING
LANGUAGE PYTHON
RUNTIME_VERSION = 3.9
PACKAGES=('snowflake-snowpark-python')
HANDLER='echo.echo_fn'
IMPORTS=('/echo.py');

GRANT USAGE ON FUNCTION ext_code_schema.py_echo_fn(DATA string)
  TO APPLICATION ROLE app_instance_role;

# some python file echo.py
@udf(name="echo_fn")
def echo_fn(data) -> str:
  return 'echo_fn: ' + str

-- Sample setup_script.sql SQL file for a Snowflake Native App

-- User-written code
CREATE OR REPLACE APPLICATION ROLE app_instance_role;

CREATE OR ALTER VERSIONED SCHEMA ext_code_schema;
GRANT USAGE ON SCHEMA ext_code_schema TO APPLICATION ROLE app_instance_role;

-- Snowflake CLI generated code
CREATE OR REPLACE FUNCTION ext_code_schema.py_echo_fn(DATA string)
  RETURNS STRING
  LANGUAGE PYTHON
  RUNTIME_VERSION = 3.9
  PACKAGES=('snowflake-snowpark-python')
  HANDLER='echo.echo_fn'
  IMPORTS=('/echo.py');

  GRANT USAGE ON FUNCTION ext_code_schema.py_echo_fn(string)
    TO APPLICATION ROLE app_instance_role;

Verwendung der Snowpark Python-Decorators¶

Während die Snowpark-Decorators in Snowflake CLI genauso funktionieren wie die regulären Snowpark-Python-Decorators, sollten Sie die folgenden Unterschiede beachten, wenn Sie Python-Code-Dateien speziell für eine Snowflake Native App schreiben:

• Sie können in diesen Dateien keine Sitzungs-Objekte verwenden, da Snowflake CLI diese Python-Dateien in einer Sandbox-Umgebung ohne Verbindung zu Snowflake ausführt. Infolgedessen führt jeder Verweis auf eine Snowpark Sitzung zu einem Fehler.

• Sie können nur die Snowpark Python-Decorators @udf, @sproc, @udaf und @udtf verwenden.

• Sie können diese Decorators nicht als reguläre Funktionen verwenden, um Ihren Code als Snowflake-Objekt zu registrieren. Nur Code, der explizit mit den unterstützten Decorators kommentiert ist, wird erkannt. Daher muss die Python-Funktion eine benannte Funktion sein. Lambda-Funktionen werden nicht unterstützt.

• Snowflake CLI erzeugt immer CREATE OR REPLACE-Anweisungen, wie von Snowflake empfohlen, um Funktionen und Prozeduren in Ihren Setup-Skripten zu erstellen.

# output/deploy/dest_dir1/dest_dir2/echo.py
#: @sproc(
#:    return_type=IntegerType(),
#:    input_types=[IntegerType(), IntegerType()],
#:    packages=["snowflake-snowpark-python==1.15.0"],
#:    native_app_params={
#:        "schema": "ext_code_schema",
#:        "application_roles": ["app_instance_role"],
#:    },
#: )
def add_sp(session_, x, y):
    return x + y