snow snowpark execute¶

構文¶

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

引数¶

object_type:{procedure|function}

Snowparkオブジェクトの型。

execution_identifier

プロシージャ/関数の実行識別子。例: hello(1, 'world').

オプション¶

--connection, -c, --environment TEXT

config.toml ファイルで定義されている接続の名前。デフォルト: デフォルト

--host TEXT

接続用のホストアドレス。接続に指定された値を上書きします。

--port INTEGER

接続のポート。接続に指定された値を上書きします。

--account, --accountname TEXT

Snowflakeアカウントに割り当てられた名前。接続に指定された値を上書きします。

--user, --username TEXT

Snowflakeに接続するユーザー名。接続に指定された値を上書きします。

--password TEXT

Snowflakeのパスワード。接続に指定された値を上書きします。

--authenticator TEXT

Snowflakeの認証コード。接続に指定された値を上書きします。

--private-key-file, --private-key-path TEXT

Snowflake プライベートキーファイルへのパス。接続に指定された値を上書きします。

--token TEXT

Snowflake接続時に使用する OAuth トークン。

--token-file-path TEXT

Snowflake接続時に使用する OAuth トークンを含むファイルへのパス。

--database, --dbname TEXT

使用するデータベース。接続に指定された値を上書きします。

--schema, --schemaname TEXT

使用するデータベーススキーマ。接続に指定された値を上書きします。

--role, --rolename TEXT

使用するロール。接続に指定された値を上書きします。

--warehouse TEXT

使用するウェアハウス名。接続に指定された値を上書きします。

--temporary-connection, -x

config で定義された接続ではなく、コマンドラインパラメーターで定義された接続を使用します。デフォルト: false。

--mfa-passcode TEXT

多要素認証（MFA）に使用するトークン。

--enable-diag

接続診断レポートを作成するかどうか。デフォルト: false。

--diag-log-path TEXT

生成されたレポートのパス。デフォルトはシステム仮ディレクトリです。デフォルト: <system_temporary_directory>.

--diag-allowlist-path TEXT

allowlist パラメーターを含む JSON ファイルへのパス。

--oauth-client-id TEXT

Snowflake統合のためにIDプロバイダーが提供するクライアントIDの値。

--oauth-client-secret TEXT

Snowflake 統合用に ID プロバイダーが提供するクライアントシークレットの値。

--oauth-authorization-url TEXT

認証コードをドライバーに提供する ID プロバイダーエンドポイント。

--oauth-token-request-url TEXT

ドライバーにアクセストークンを供給する ID プロバイダーのエンドポイント。

--oauth-redirect-uri TEXT

URI 認証コードのリダイレクトに使用します。

--oauth-scope TEXT

ID プロバイダー承認リクエストで要求された範囲。

--oauth-disable-pkce

コード交換の証明キー (PKCE) を無効にします。デフォルト:False。

--oauth-enable-refresh-tokens

実際のアクセストークンが古くなった場合に、サイレント再認証コードを有効にします。デフォルト:False。

--oauth-enable-single-use-refresh-tokens

シングルユース・更新・トークンのセマンティクスにオプトインするかどうか。デフォルト:False。

--client-store-temporary-credential

仮認証情報を保存します。

--format [TABLE|JSON|JSON_EXT|CSV]

出力形式を指定します。デフォルト: TABLE

--verbose, -v

ログレベル info 以上のログエントリを表示します。デフォルト: false。

--debug

ログレベル debug 以上のログ エントリを表示します。デバッグログには追加情報が含まれます。デフォルト: false。

--silent

コンソールへの中間出力をオフにします。デフォルト: false。

--enhanced-exit-codes

終了エラーコードをエラーのタイプによって区別します。デフォルト: false。

--help

このコマンドのヘルプテキストを表示します。

使用上の注意¶

snow snowpark execute コマンドは、Snowflakeに保存されている関数またはプロシージャを実行します。接続用に定義されたデータベースを使用します。

使用するコマンドシェルに応じて、 例 セクションに示すように、 execution_identifier 引数を引用符で囲む必要がある場合があります。

例¶

以下の例では、 hello_function というSnowpark関数を呼び出しています。

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

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