ユーザー定義関数の作成¶

UDF の作成¶

1. Python、Java、Scalaなど、サポートされている言語のいずれかを使用して、関数ロジックをハンドラーとして記述します。

2. ツールまたは API を選択し、作成したハンドラーで関数を作成します。

   それぞれの情報については、 UDFs 作成ツール をご覧ください。

   SQL	SQL を使用し、いくつかの言語のいずれかでロジックを記述します。
   Snowpark	Java、Python、または Scala 用の Snowpark API を使用します。
   コマンドライン	CLI コマンドを実行して関数を作成します。
   Python API	クライアント側のPythonコマンドを実行して関数を作成します。
   REST	RESTful API に関数の作成リクエストを行います。

3. 必要に応じて、いくつかのツールのいずれかを使用して 関数を実行します。

UDFs 作成ツール¶

言語やスキルセットに応じて、Snowflakeで利用可能ないくつかの方法のいずれかを使用して、 UDF を作成できます。以下の表から、お客様のニーズに合ったツールをお選びください。

キー・プロパティ¶

次に、関数を作成するときに必要な、または通常使用される、プロパティの一部について説明します。

関数名:

関数名はハンドラー名と一致する必要はありません。名前の制約と規則の詳細については、 プロシージャおよび UDFs の命名とオーバーロード をご参照ください。

引数:

要件の詳細については、 UDFs およびストアドプロシージャの引数の定義 を参照してください。

戻り型:

Snowflakeが SQL データ型をハンドラーデータ型にマップする方法については、 SQL とハンドラー言語間のデータ型マッピング をご参照ください。

ハンドラー名:

必要な場合は、関数が実行されたときに実行されるコードを含むクラスまたはメソッドの名前です。Java、Python、およびScalaで記述されたハンドラーに対してのみ、ハンドラー名を指定する必要があります。JavaScript および SQL ハンドラーの場合、インラインで指定されたすべてのコードがハンドラーとして実行されます。

依存関係:

Java、Python、Scalaで書かれたハンドラーの場合、関数を作成する際などにSnowparkライブラリを指定する必要がある場合もあります。

ハンドラーで依存関係を利用できるようにする方法の詳細については、 コードで依存関係を利用できるようにする方法 をご参照ください。

ハンドラー言語ランタイム:

ハンドラー言語がJava、Python、Scalaの場合、サポートされているランタイムバージョンを示すためにランタイムバージョンを指定します。デフォルトのバージョンを使用している場合、そのデフォルトは時間の経過とともに変更されることに留意してください。

アクセス制御の要件¶

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

スキーマ内のオブジェクトに対して操作を実行するには、親データベースとスキーマに対する USAGE 権限が必要です。スキーマに対する 任意の権限を付与されたロールは、そのロールがスキーマを解決できることに注意してください。たとえば、スキーマに対するCREATE権限を付与されたロールは、そのスキーマにオブジェクトを作成できますが、そのスキーマに対するUSAGE*も*付与されている必要はありません。

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意¶

以下の使用上の注意は、ハンドラーを記述するためにサポートされている言語に関連するものです。以下のセクションのリファレンスでは、 SQL CREATE FUNCTION コマンドの句に言及していますが、これらの句は通常、関数を作成するために使用できる他のツールでは別の方法で表現されます。

SQL で UDF を作成する¶

SQL で、以下の手順を使用して UDF を作成できます。

次のステップで UDF を作成します。

1. UDF が呼び出されたときに実行するハンドラーコードを記述します。

   サポートされているハンドラー言語のいずれかを使用できます。詳細については、 対応言語とツール をご参照ください。

2. ハンドラーコードを CREATE FUNCTION SQL ステートメントとインラインで保持するか、ステージで参照するかを選択します。

   それぞれに利点があります。詳細については、 ハンドラーコードのインラインまたはステージ上での保持 をご参照ください。

3. SQL で CREATE FUNCTION ステートメントを実行し、関数のプロパティを指定します。

   次の例のコードは、インラインハンドラー HandlerClass.handlerMethod を使用して function_name という名前の UDF を作成します。

   create function function_name(x integer, y integer)
     returns integer
     language java
     handler='HandlerClass.handlerMethod'
     target_path='@~/HandlerCode.jar'
     as
     $$
         class HandlerClass {
             public static int handlerMethod(int x, int y) {
               return x + y;
             }
         }
     $$;
   

   Copy

   次に、関数を作成するときに必要な、または通常使用される、プロパティの一部について説明します。

   • 関数名。

     UDF 名は、ハンドラーメソッドの名前と一致する必要はありません。CREATE FUNCTIONステートメントは、UDF名をハンドラーに関連付けます。

     名前の制約と規則の詳細については、 プロシージャおよび UDFs の命名とオーバーロード をご参照ください。

   • 関数の引数（存在する場合）。

     UDFs およびストアドプロシージャの引数の定義 をご参照ください。

   • RETURNS 句を使用した戻り型。

     スカラー戻り値の場合、 RETURNS 句は単一の戻り型を指定します。表形式の戻り値の場合、 RETURNS は、表形式内にある戻り値の列の型を指定する TABLE キーワードを指定します。

     Snowflakeが SQL データ型をハンドラーデータ型にマップする方法については、 プロシージャおよび UDFs の命名とオーバーロード をご参照ください。

   • HANDLER 句を使用したハンドラー名。

     必要な場合、これは UDF が呼び出されたときに実行されるコードを含むクラスまたはメソッドの名前です。JavaおよびPythonで記述されたハンドラーの場合にのみ、ハンドラー名を指定する必要があります。JavaScript および SQL ハンドラーの場合、インラインで指定されたすべてのコードがハンドラーとして実行されます。

     次のテーブルは、ハンドラー言語と関数の型に基づく HANDLER 句の値の形式を示しています。

     ハンドラー言語	UDF	UDTF
     Java	クラスとメソッド名。 例: MyClass.myMethod	クラス名のみ。ハンドラーメソッド名は、必要なインターフェイスによって事前に決定されます。
     JavaScript	なし。	なし。
     Python	クラスが使用されている場合は、クラスとメソッド名。それ以外の場合は、関数名。 例： module.my_function または my_function	クラス名のみ。ハンドラーメソッド名は、必要なインターフェイスによって事前に決定されます。
     SQL	なし。	なし。

   • IMPORTS または PACKAGES 句を使用したハンドラーが必要とする依存関係（存在する場合）。

     ハンドラーで依存関係を利用できるようにする方法の詳細については、 コードで依存関係を利用できるようにする方法 をご参照ください。

   • RUNTIME_VERSION 句を使用したハンドラー言語ランタイム。

     ハンドラー言語がJavaまたはPythonの場合は、 RUNTIME_VERSION 句を使用して、使用するサポートされているランタイムバージョンを指定します。句を省略すると、Snowflakeに対してデフォルトを使用するように求められますが、これは将来変更される可能性があります。