Python UDFsの作成¶

Pythonモジュールと関数の記述¶

以下の仕様に従うモジュールを作成します。

• モジュールを定義します。モジュールは、Pythonの定義とステートメントを含むファイルです。

• モジュール内で関数を定義します。

• 関数が引数を受け入れる場合、各引数は SQL-Python型マッピングテーブル の Python Data Type 列で指定されたデータ型の1つである必要があります。

  関数引数は、名前ではなく位置によってバインドされます。UDFに渡される最初の引数は、Python関数が最初に受け取る引数です。

• 適切な戻り値を指定します。Python UDFはスカラー関数である必要があるため、呼び出されるたびに1つの値を返す必要があります。戻り値の型は、 SQL-Python型マッピングテーブル の Python Data Type 列で指定されたデータ型の1つである必要があります。戻り値の型は、 CREATE FUNCTION ステートメントの RETURNS 句で指定されたSQLデータ型と互換性がある必要があります。

• モジュールには複数の関数を含めることができます。Snowflakeによって呼び出される関数は、同じモジュールまたは他のモジュール内の他の関数を呼び出すことができます。

• 関数（および関数によって呼び出される関数）は、 Python UDFs に対してSnowflakeが課す制約 に準拠する必要があります。

インラインPython UDF の作成¶

インライン UDFの場合は、CREATEFUNCTIONステートメントの一部としてPythonソースコードを提供します。

たとえば、次のステートメントは、指定された整数に1を追加するインラインPython UDFを作成します。

create or replace function addone(i int)
returns int
language python
RUNTIME_VERSION = '3.9'
handler = 'addone_py'
as
$$
def addone_py(i):
  return i+1
$$;

Pythonソースコードは AS 句で指定されます。ソースコードは、一重引用符またはドル記号（$$）のペアで囲むことができます。ソースコードに一重引用符が埋め込まれている場合は、通常、二重ドル記号を使用する方が簡単です。

UDF を呼び出します。

select addone(10);

出力は次のとおりです。

+------------+
| ADDONE(10) |
|------------|
|         11 |
+------------+

Pythonソースコードには複数のモジュールとモジュール内の複数の関数を含めることができるため、 HANDLER 句は呼び出すモジュールと関数を指定します。

インラインPython UDFは、 IMPORTS 句に含まれるモジュールのコードを呼び出すことができます。

CREATE FUNCTION ステートメントの構文の詳細については、 CREATE FUNCTION をご参照ください。

その他の例については、 インラインPython UDFの例 をご参照ください。

ステージからアップロードされたコードを使用したPython UDF の作成¶

次のステートメントは、 ステージ からアップロードされたコードを使用して単純なPython UDFを作成します。ファイルをホストするステージは、UDFの 所有者 によって読み取り可能である必要があります。また、ZIPファイルは自己完結型である必要があり、実行する追加のセットアップスクリプトに依存しないようにする必要があります。

ソースコードを含む sleepy.py という名前のPythonファイルを作成します。

def snore(n):   # return a series of n snores
    result = []
    for a in range(n):
        result.append("Zzz")
    return result

SnowSQL （CLI クライアント） を起動し、 PUT コマンドを使用して、ファイルをローカルファイルシステムから @~ という名前のデフォルトのユーザーステージにコピーします。（PUT コマンドは、Snowflake GUIで実行できないことに注意してください。）

put
file:///Users/Me/sleepy.py
@~/
auto_compress = false
overwrite = true
;

ファイルを削除または名前変更すると、UDFを呼び出すことができなくなります。ファイルを更新する必要がある場合はファイルを更新できますが、更新中はUDFを呼び出すことができません。古いファイルがまだステージにある場合、 PUT コマンドには OVERWRITE=TRUE 句を含める必要があります。

UDFを作成します。ハンドラーはモジュールと関数を指定します。

create or replace function dream(i int)
returns variant
language python
RUNTIME_VERSION = '3.9'
handler = 'sleepy.snore'
imports = ('@~/sleepy.py')

UDF を呼び出します。

select dream(3);

+----------+
| DREAM(3) |
|----------|
| [        |
|   "Zzz", |
|   "Zzz", |
|   "Zzz"  |
| ]        |
+----------+

create or replace function multiple_import_files(s string)
returns string
language python
RUNTIME_VERSION = 3.9
imports=('@python_udf_dep/bar/python_imports_a.zip', '@python_udf_dep/foo/python_imports_b.zip')
handler='compute'
as
$$
def compute(s):
  return s
$$;