Preparando uma pasta local com artefatos Snowflake Native App configurados¶

Crie uma pasta local com artefatos configurados¶

O comando snow app bundle cria um diretório local no projeto, preenche-o com a estrutura de arquivo especificada no arquivo de definição do projeto e gera declarações CREATE FUNCTION ou CREATE PROCEDURE em scripts de configuração do Snowflake Native App a partir do código Snowpark Python que inclui decoradores (como @sproc ou @udaf). Para obter mais informações, consulte a documentação do Snowpark Python correspondente ao decorador de função escolhido, como snowflake.snowpark.functions.udaf.

Os comandos snow app deploy e snow app run já usam essa funcionalidade. No entanto, agora com um comando explícito snow app bundle à sua disposição, é possível explorar esse diretório antes que ele seja carregado no estágio, para verificar se os artefatos foram criados conforme o esperado.

Para criar uma pasta local com os artefatos configurados, faça o seguinte:

1. Crie ou verifique seu arquivo de definição de projeto Snowflake snowflake.yml, como:

   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. No diretório do projeto, execute o comando snow app bundle para criar o diretório temporário output/deploy que contém os artefatos configurados.

   snow app bundle
   

   Copy

3. Verifique se o conteúdo do diretório de saída ou de implementação corresponde às regras especificadas no arquivo snowflake.yml. Se você invocou o processamento de anotação do Snowpark em seus arquivos Python, poderá ver o código gerado no script de configuração alterado no diretório.

Para obter mais informações, consulte o comando snow app bundle.

Como gerar código SQL usando o processamento de anotação do Snowpark¶

Como desenvolvedor de Snowflake Native App com experiência limitada de SQL, você pode achar complicado escrever e manter scripts de configuração, que podem ficar muito grandes e complicados com o tempo. Os scripts de configuração contêm toda a lógica do aplicativo que um cliente pode usar com seus dados e, portanto, são uma parte necessária do desenvolvimento de um Snowflake Native App. Um dos principais componentes dos scripts de configuração é a capacidade de usar funções de extensão do Snowpark Python para funções e procedimentos armazenados. Além de escrever o código do Snowpark em Python, Java ou outras linguagens compatíveis com Snowpark, é necessário escrever as partes correspondentes dessas funções e procedimentos usando SQL no script de configuração.

Por exemplo, você pode criar uma função básica e um procedimento armazenado usando o Snowpark Python, conforme mostrado:

# 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

Você precisaria então carregar o arquivo em um estágio e consultá-lo no código SQL do script de configuração, semelhante ao seguinte:

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

Como usar os decoradores do Snowpark Python¶

Embora os decoradores do Snowpark em Snowflake CLI funcionem da mesma forma que os decoradores Snowpark Python regulares, é necessário estar ciente das seguintes diferenças ao escrever arquivos de código Python especificamente para um Snowflake Native App:

• Não é possível usar nenhum objeto Session nesses arquivos, pois Snowflake CLI executa esses arquivos Python em um ambiente sandbox sem conexão com o Snowflake. Como resultado, qualquer referência a um Session de Snowpark resulta em um erro.

• É possível usar apenas os decoradores Snowpark Python @udf, @sproc, @udaf e @udtf.

• Você não pode usar esses decoradores como funções regulares para registrar seu código como um objeto Snowflake. Somente código explicitamente anotado com os decoradores compatíveis é reconhecido. Portanto, a função Python deve ser uma função nomeada. Funções lambda não são compatíveis.

• Snowflake CLI sempre gera instruções CREATE OR REPLACE, conforme recomendado pela Snowflake, para criar funções e procedimentos em seus scripts de configuração.

# 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