snow snowpark execute¶

Executa um procedimento ou função em um ambiente especificado.

Sintaxe¶

snow snowpark execute
  <object_type>
  <execution_identifier>
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --private-key-file <private_key_file>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes

Copy

Argumentos¶

object_type:{procedure|function}: Tipo de objeto Snowpark.
execution_identifier: Identificador de execução do procedimento/função. Por exemplo: hello(1, “world”).

Opções¶

--connection, -c, --environment TEXT: Nome da conexão, conforme definido no arquivo config.toml. Padrão: default.
--host TEXT: Endereço do host da conexão. Substitui o valor especificado para a conexão.
--port INTEGER: Porta para a conexão. Substitui o valor especificado para a conexão.
--account, --accountname TEXT: Nome atribuído à sua conta Snowflake. Substitui o valor especificado para a conexão.
--user, --username TEXT: Nome de usuário para se conectar ao Snowflake. Substitui o valor especificado para a conexão.
--password TEXT: Senha do Snowflake. Substitui o valor especificado para a conexão.
--authenticator TEXT: Autenticador Snowflake. Substitui o valor especificado para a conexão.
--private-key-file, --private-key-path TEXT: Caminho do arquivo de chave privada Snowflake. Substitui o valor especificado para a conexão.
--token-file-path TEXT: Caminho para o arquivo com um token OAuth a ser usado ao se conectar ao Snowflake.
--database, --dbname TEXT: Banco de dados a ser usado. Substitui o valor especificado para a conexão.
--schema, --schemaname TEXT: Esquema de banco de dados a ser usado. Substitui o valor especificado para a conexão.
--role, --rolename TEXT: Função a ser usada. Substitui o valor especificado para a conexão.
--warehouse TEXT: Warehouse a ser usado. Substitui o valor especificado para a conexão.
--temporary-connection, -x: Usa uma conexão definida com parâmetros de linha de comando, em vez de uma definida na configuração. Padrão: falso.
--mfa-passcode TEXT: Token a ser usado para autenticação multifator (MFA).
--enable-diag: Se deve gerar um relatório de diagnóstico de conexão. Padrão: falso.
--diag-log-path TEXT: Caminho para o relatório gerado. O padrão é o diretório temporário do sistema. Padrão: <system_temporary_directory>.
--diag-allowlist-path TEXT: Caminho para um arquivo JSON que contém parâmetros da lista de permissões.
--oauth-client-id TEXT: Valor do ID de cliente fornecido pelo provedor de identidade para integração com o Snowflake.
--oauth-client-secret TEXT: Valor do segredo do cliente fornecido pelo provedor de identidade para integração com o Snowflake.
--oauth-authorization-url TEXT: Ponto de extremidade do provedor de identidade que fornece o código de autorização ao driver.
--oauth-token-request-url TEXT: Ponto de extremidade do provedor de identidade que fornece os tokens de acesso ao driver.
--oauth-redirect-uri TEXT: URI a ser usado para redirecionamento de código de autorização.
--oauth-scope TEXT: Escopo solicitado na solicitação de autorização do provedor de identidade.
--oauth-disable-pkce: Desativa o Proof Key for Code Exchange (PKCE). Padrão: False.
--oauth-enable-refresh-tokens: Permite uma reautenticação silenciosa quando o token de acesso real fica desatualizado. Padrão: False.
--oauth-enable-single-use-refresh-tokens: Se o usuário deve optar pela semântica de token de atualização de uso único. Padrão: False.
--client-store-temporary-credential: Armazena a credencial temporária.
--format [TABLE|JSON]: Especifica o formato de saída. Padrão: TABLE.
--verbose, -v: Exibe entradas de log para os níveis de log info e superiores. Padrão: falso.
--debug: Exibe entradas de log para níveis de log de depuração e superiores; os logs de depuração contêm informações adicionais. Padrão: falso.
--silent: Desliga a saída intermediária para o console. Padrão: falso.
--enhanced-exit-codes: Diferencia os códigos de erro de saída com base no tipo de falha. Padrão: falso.

--help: Exibe o texto de ajuda para este comando.

Notas de uso¶

O comando snow snowpark execute executa uma função ou procedimento armazenado no Snowflake. Ele usa o banco de dados definido para a conexão.

Com base no shell de comando que você usa, pode ser necessário encapsular o argumento execution_identifier entre aspas, conforme ilustrado na seção Exemplos.

Exemplos¶

O exemplo a seguir chama uma função Snowpark chamada hello_function:

snow snowpark execute function "hello_function('Olaf')"

Copy

+--------------------------------------+
| key                    | value       |
|------------------------+-------------|
| HELLO_FUNCTION('Olaf') | Hello Olaf! |
+--------------------------------------+