Préparation d’un dossier local avec des artefacts Snowflake Native App configurés¶

Créer un dossier local avec des artefacts configurés¶

La commande snow app bundle crée un répertoire local dans votre projet, le remplit avec la structure de fichiers que vous avez spécifiée dans le fichier de définition du projet et génère des déclarations CREATE FUNCTION ou CREATE PROCEDURE dans les scripts d’installation de Snowflake Native App à partir du code Snowpark Python qui inclut des décorateurs (tels que @sproc ou @udaf). Pour plus d’informations, consultez la documentation Python Snowpark correspondant au décorateur de fonction choisi, tel que snowflake.snowpark.functions.udaf.

Les commandes snow app deploy et snow app run utilisent déjà cette fonctionnalité. Cependant, maintenant avec une commande snow app bundle explicite à votre disposition, vous pouvez explorer ce répertoire avant qu’il ne soit téléchargé dans la zone de préparation, pour vérifier que les artefacts ont été créés comme prévu.

Pour créer un dossier local avec les artefacts configurés, procédez comme suit :

1. Créez ou vérifiez votre fichier de définition de projet snowflake.yml Snowflake, tel que :

   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. Depuis votre répertoire de projet, exécutez la commande snow app bundle pour créer le répertoire temporaire output/deploy qui contient vos artefacts configurés.

   snow app bundle
   

   Copy

3. Vérifiez que le contenu du répertoire de sortie ou de déploiement correspond aux règles que vous avez spécifiées dans le fichier snowflake.yml. Si vous avez appelé le traitement des annotations Snowpark dans vos fichiers Python, vous pouvez voir le code généré dans le script d’installation modifié dans le répertoire.

Pour plus d’informations, consultez la commande snow app bundle.

Générer du code SQL en utilisant le traitement des annotations Snowpark¶

En tant que développeur de Snowflake Native App avec des notions limitées en SQL, vous pourriez trouver cela fastidieux d’écrire et de maintenir des scripts d’installation, qui peuvent devenir assez volumineux et compliqués au fil du temps. Les scripts d’installation contiennent toute la logique d’application qu’un client peut utiliser avec ses données et constituent donc une partie obligatoire du développement d’une Snowflake Native App. L’un des composants principaux des scripts d’installation est votre capacité à utiliser les fonctions d’extension Snowpark Python pour les fonctions et les procédures stockées. En plus d’écrire du code Snowpark en Python, Java ou d’autres langages pris en charge par Snowpark, vous devez écrire les parties correspondantes de ces fonctions et procédures en utilisant SQL dans le script d’installation.

Par exemple, vous pouvez créer une fonction de base et une procédure stockée à l’aide de Snowpark Python, comme indiqué :

# 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

Vous devrez ensuite télécharger le fichier dans une zone de préparation et vous y référer à partir du code SQL du script d’installation, semblable au suivant :

-- 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;

Utilisation de décorateurs Snowpark Python¶

Pendant que les décorateurs Snowpark dans Snowflake CLI fonctionnent de la même manière que les décorateurs Python Snowpark classiques, vous devez être conscient des différences suivantes lors de l’écriture de fichiers de code Python spécifiquement pour une Snowflake Native App :

• Vous ne pouvez pas utiliser d’objets Session dans ces fichiers, comme Snowflake CLI exécute ces fichiers Python dans un environnement sandbox sans connexion à Snowflake. En conséquence, toute référence à un objet Snowpark Session entraîne une erreur.

• Vous ne pouvez utiliser que les décorateurs @udf, @sproc, @udaf et @udtf Snowpark Python.

• Vous ne pouvez pas utiliser ces décorateurs comme fonctions normales pour enregistrer votre code en tant qu’objet Snowflake. Seul le code explicitement annoté avec les décorateurs pris en charge est reconnu. Par conséquent, la fonction Python doit être une fonction nommée. Les fonctions Lambda ne sont pas prises en charge.

• Snowflake CLI génère toujours des instructions CREATE OR REPLACE, comme recommandé par Snowflake, pour créer des fonctions et des procédures dans vos scripts d’installation.

# 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