DESCRIBE FUNCTION (Snowpark Container Services)¶
シグネチャ(引数)、戻り値、言語、ボディ(Snowpark Container Services サービスへのパス)を含む、指定された サービス関数 を記述します。
- こちらもご参照ください。
構文¶
{ DESC | DESCRIBE } FUNCTION [ IF EXISTS ] <name> ( [ <arg_data_type> ] [ , ... ] )
必須パラメーター¶
name説明するサービスの識別子を指定します。識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。
( [ arg_name arg_data_type ] [ , ... ] )サービス関数の引数/入力を指定します。これらは、サービスが期待する引数に対応している必要があります。
引数がない場合は、引数名とデータ型なしで括弧を含めます。
アクセス制御の要件¶
この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。
権限 |
オブジェクト |
注意 |
|---|---|---|
USAGE |
サービス関数 |
スキーマ内のオブジェクトを操作するには、親データベースの少なくとも1つの権限と、親スキーマの少なくとも1つの権限が必要です。
指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。
セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。
使用上の注意¶
このコマンドの出力を後処理するには、 パイプ演算子 (
->>)または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。
出力列を参照する場合は、列名に 二重引用符で囲まれた識別子 を使用します。たとえば、出力列
typeを選択するには、SELECT "type"を指定します。SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。
例¶
Tutorial-1 では、サービス関数(my_echo_udf)を作成しています。次の DESC FUNCTION コマンドは、サービス機能の説明を返します:
DESC FUNCTION my_echo_udf(VARCHAR);
出力例:
+--------------------+----------------------+
| property | value |
|--------------------+----------------------|
| signature | (INPUTTEXT VARCHAR) |
| returns | VARCHAR |
| language | NULL |
| null handling | CALLED ON NULL INPUT |
| volatility | VOLATILE |
| body | /echo |
| headers | null |
| context_headers | null |
| max_batch_rows | not set |
| service | ECHO_SERVICE |
| service_endpoint | echoendpoint |
| max_batch_retries | 3 |
| on_batch_failure | ABORT |
| batch_timeout_secs | not set |
+--------------------+----------------------+