SHOW FUNCTIONS¶
Snowflakeが提供するすべてのネイティブ(つまり、システム定義/組み込み)スカラー関数、さらにユーザー定義関数 UDFs またはアカウントで作成された外部関数のすべてをリストします。
詳細については、 関数およびストアドプロシージャリファレンス、 ユーザー定義関数の概要 および 外部関数の記述 をご参照ください。
- こちらもご参照ください。
SHOW USER FUNCTIONS、 SHOW EXTERNAL FUNCTIONS、 CREATE FUNCTION、 DROP FUNCTION、 ALTER FUNCTION、 DESCRIBE FUNCTION
構文¶
SHOW FUNCTIONS [ LIKE '<pattern>' ]
[ IN
{
ACCOUNT |
CLASS <class_name> |
DATABASE |
DATABASE <database_name> |
SCHEMA |
SCHEMA <schema_name> |
<schema_name>
}
]
パラメーター¶
LIKE 'pattern'
オプションで、オブジェクト名でコマンド出力をフィルタリングします。フィルターは、 SQL ワイルドカード文字(
%
および_
)をサポートする、 大文字と小文字を区別しない パターンマッチングを使用します。たとえば、次のパターンは 同じ 結果を返します。
... LIKE '%testing%' ...
... LIKE '%TESTING%' ...
. デフォルト: 値なし(フィルタリングは出力に非適用)。
[ IN ... ]
オプションで、コマンドのスコープを指定します。次のいずれかを指定します。
ACCOUNT
アカウント全体の記録を返します。
CLASS class_name
指定したクラス(
class_name
)の記録を返します。DATABASE
、 .DATABASE db_name
現在使用中のデータベースまたは指定されたデータベース(
db_name
)の記録を返します。db_name
なしでDATABASE
を指定し、かつデータベースが使用されていない場合、キーワードは出力に影響しません。SCHEMA
、 .SCHEMA schema_name
、 .schema_name
現在使用中のスキーマまたは指定されたスキーマ(
schema_name
)の記録を返します。データベースが使用中の場合、または完全修飾
schema_name
(例:db.schema
) を指定する場合、SCHEMA
はオプションです。データベースが使用されていない場合は、
SCHEMA
を指定しても出力には影響しません。
デフォルト: セッションで現在使用中のデータベースがあるかどうかによって異なります。
データベース:
DATABASE
がデフォルトです(つまり、コマンドはデータベースで表示する権限を持つオブジェクトを返します)。データベースなし:
ACCOUNT
はデフォルトです(つまり、コマンドは、アカウントで表示する権限を持つオブジェクトを返します)。
出力¶
コマンド出力では、次の列に関数プロパティとメタデータが提供されます。
列 |
説明 |
---|---|
|
関数が作成された時のタイムスタンプ。 |
|
関数の名前。 |
|
関数が存在するスキーマの名前。(組み込み関数の場合は NULL。) |
|
関数が組み込み関数の場合は |
|
関数が集計関数である場合は |
|
関数が ANSI SQL 標準の一部として定義されている場合は |
|
引数の最小数 |
|
引数の最大数 |
|
引数と戻り値のデータ型。オプションの引数は、 |
|
関数の説明。 |
|
関数が存在するデータベースの名前。(組み込み関数の場合は NULL。) |
|
関数がテーブル関数の場合は |
|
関数が CLUSTER BY 式で使用できる場合は |
|
関数がセキュア関数の場合は |
|
関数が外部関数の場合は |
|
組み込み関数の場合、この列には「SQL」と表示されます。 ユーザー定義関数の場合、この列には関数が記述された言語が表示されます(例: JAVASCRIPT または SQL)。 外部関数の場合、この列には「EXTERNAL」と表示されます。 |
|
関数がメモ化可能な場合は |
|
この列は、将来の機能用プレースホルダーです。 |
使用上の注意¶
プレフィックス
is_
で始まる列は、Y
(はい)またはN
(いいえ)のいずれかを返します。このコマンドの実行は、稼働中のウェアハウスを必要としません。
コマンドは、コマンドを実行するために使用されるロールのアクセス権によって決定された通り、指定されたオブジェクトタイプに対して 最大 10Kの記録を返します。フィルタが適用されていても、10Kの制限を超える記録は返されません。
10Kを超える記録が存在する結果を表示するには、 Snowflake Information Schema で対応するビュー(存在する場合)をクエリします。
このコマンドの出力を後処理するには、 RESULT_SCAN 関数を使用できます。この関数は、出力をクエリ可能なテーブルとして扱います。
CLASS
を指定すると、コマンドは次の列のみを返します。| name | min_num_arguments | max_num_arguments | arguments | descriptions | language |
このコマンドの出力には、
SN_TEMP_OBJECT_<n>
(<n>
は数値)のような名前のオブジェクトが含まれる場合があります。これらは、ユーザーの代理として Snowpark ライブラリにより作成される仮オブジェクトです。
例¶
すべての関数を表示します。
SHOW FUNCTIONS;
指定された正規表現に一致する関数のみを表示します。
SHOW FUNCTIONS LIKE 'SQUARE'; ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+ created_on | name | schema_name | is_builtin | is_aggregate | is_ansi | min_num_arguments | max_num_arguments | arguments | description | language | is_memoizable | is_data_metric | ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+ | SQUARE | | Y | N | Y | 1 | 1 | SQUARE(NUMBER(38,0)) RETURN NUMBER(38,0), SQUARE(FLOAT) RETURN FLOAT | Compute the square of the input expression. | SQL | N | N | ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+