Erstellen von Python-UDFs¶

Schreiben von Python-Modulen und -Funktionen¶

Schreiben Sie ein Modul, die den unten stehenden Spezifikationen entspricht:

• Definieren Sie das Modul. Ein Modul ist eine Datei, die Python-Definitionen und -Anweisungen enthält.

• Definieren Sie innerhalb des Moduls eine Funktion.

• Wenn die Funktion Argumente akzeptiert, muss jedes Argument einen Datentyp aufweisen, der in der Spalte Python Data Type der SQL-Python-Typzuordnungstabelle angegeben ist.

  Funktionsargumente werden über die Position gebunden, nicht über den Namen. Das erste Argument, das an die UDF übergeben wird, ist das erste Argument, das von der Python-Funktion empfangen wird.

• Geben Sie einen geeigneten Rückgabewert an. Da eine Python-UDF eine skalare Funktion sein muss, muss sie bei jedem Aufruf einen Wert zurückgeben. Der Rückgabewert muss einen Datentyp aufweisen, der in der Spalte Python Data Type der SQL-Python-Typzuordnungstabelle angegebenen ist. Der Typ des Rückgabewerts muss mit dem SQL-Datentyp kompatibel sein, der in der RETURNS-Klausel der CREATE FUNCTION-Anweisung angegeben ist.

• Ihr Modul kann mehr als eine Funktion enthalten. Die Funktion, die von Snowflake aufgerufen wird, kann andere Funktionen im selben Modul oder in anderen Modulen aufrufen.

• Ihre Funktion (und alle Funktionen, die von Ihrer Funktion aufgerufen werden) muss die Snowflake-Einschränkungen für Python-UDFs einhalten.

Erstellen einer Inline-Python-UDF¶

Bei einer Inline-UDF stellen Sie den Python-Quellcode als Teil der CREATE FUNCTION -Anweisung bereit.

Die folgende Anweisung erstellt zum Beispiel eine Inline-Python-UDF, die zu einer gegebenen ganzen Zahl den Wert 1 addiert:

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
$$;

Der Python-Quellcode wird in der AS-Klausel angegeben. Der Quellcode kann entweder in einfache Anführungszeichen oder in doppelte Dollarzeichen ($$) eingeschlossen sein. Die Verwendung der doppelten Dollarzeichen ist normalerweise einfacher, wenn der Quellcode eingebettete einfache Anführungszeichen enthält.

Aufrufen der UDF:

select addone(10);

Und hier ist die Ausgabe:

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

Der Python-Quellcode kann mehr als ein Modul und mehr als eine Funktion in einem Modul enthalten. Daher werden Modul und Funktion für den Aufruf in der HANDLER-Klausel angegeben.

Eine Inline-Python-UDF kann Code in Modulen aufrufen, die in der IMPORTS-Klausel enthalten sind.

Weitere Informationen zur CREATE FUNCTION-Anweisung finden Sie unter CREATE FUNCTION.

Weitere Beispiele finden Sie unter Beispiele für Inline-Python-UDFs.

Erstellen eines Python-UDF mit aus einem Stagingbereich hochgeladenem Code¶

Mit den folgenden Anweisungen wird eine einfache Python-UDF erstellt, deren Code aus einem Stagingbereich hochgeladen wird. Der Stagingbereich, der die Datei hostet, muss für den Eigentümer der UDF-Datei lesbar sein. Außerdem müssen ZIP-Dateien eigenständig sein und dürfen keine zusätzlichen Setup-Skripte zur Ausführung benötigen.

Erstellen Sie eine Python-Datei mit dem Namen sleepy.py, die Ihren Quellcode enthält:

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

Starten Sie SnowSQL (CLI-Client), und verwenden Sie den PUT-Befehl, um die Datei aus dem lokalen Dateisystem in den Stagingbereich @~ des Standardbenutzers zu kopieren. (Beachten Sie, dass der PUT-Befehl nicht über die Snowflake-GUI ausgeführt werden kann.)

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

Wenn Sie die Datei löschen oder umbenennen, können Sie die UDF-Datei nicht mehr aufrufen. Wenn Sie Ihre Datei aktualisieren müssen, dann nehmen Sie die Aktualisierung vor, während keine Aufrufe an die UDF erfolgen können. Wenn sich die alte Datei noch im Stagingbereich befindet, muss der PUT-Befehl die OVERWRITE=TRUE-Klausel enthalten.

Erstellen Sie die UDF. Der Handler gibt das Modul und die Funktion an.

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

Aufrufen der 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
$$;