Kategorien:: DDL für benutzerdefinierte Funktionen, externe Funktionen und gespeicherte Prozeduren

CREATE FUNCTION¶

Erstellt eine neue UDF (benutzerdefinierte Funktion). Die Funktion kann entweder skalare Ergebnisse (als UDF) oder tabellarische Ergebnisse (als UDTF) zurückgeben.

Wenn Sie eine UDF erstellen, geben Sie einen Handler an, dessen Code in einer der unterstützten Sprachen geschrieben ist. Je nach Sprache des Handlers können Sie entweder den Quellcode des Handlers in die CREATE FUNCTION-Anweisung einbinden oder den Speicherort des Handlers von CREATE FUNCTION aus referenzieren, wo der Handler vorkompiliert oder Quellcode in einem Stagingbereich ist.

In der folgenden Tabelle sind die unterstützten Sprachen aufgeführt.

Sprache	Quellcode vorkompiliert oder im Stagingbereich bereitgestellt	Inline
Java	Ja (vorkompiliert)	Ja
JavaScript	Nein	Ja
Python	Ja (im Stagingbereich bereitgestellt)	Ja
SQL	Nein	Ja

Siehe auch:: ALTER FUNCTION, DROP FUNCTION, SHOW USER FUNCTIONS, DESCRIBE FUNCTION

Syntax¶

Die Syntax für CREATE FUNCTION variiert je nachdem, welche Programmiersprache Sie für den UDF-Handler verwenden.

Java-Handler

Verwenden Sie die folgende Syntax, wenn der Quellcode inline ist:

CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] FUNCTION [ IF NOT EXISTS ] <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
    RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
    [ [ NOT ] NULL ]
    LANGUAGE JAVA
    [ RUNTIME_VERSION = <java_jdk_version> ]
    [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
    [ VOLATILE | IMMUTABLE ]
    [ COMMENT = '<string_literal>' ]
    [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
    [ PACKAGES = ( '<package_name_and_version>' [ , ... ] ) ]
    HANDLER = '<path_to_method>'
    [ TARGET_PATH = '<stage_path_and_file_name_to_write>' ]
    AS '<function_definition>'

Verwenden Sie die folgende Syntax, wenn der Quellcode vorkompiliert ist (d. h. wenn der Code als JAR-Datei bereitgestellt wird):

CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] FUNCTION [ IF NOT EXISTS ] <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
    RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
    [ [ NOT ] NULL ]
    LANGUAGE JAVA
    [ RUNTIME_VERSION = <java_jdk_version> ]
    [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
    [ VOLATILE | IMMUTABLE ]
    [ COMMENT = '<string_literal>' ]
    IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] )
    HANDLER = '<path_to_method>'

JavaScript-Handler

CREATE [ OR REPLACE ] [ SECURE ] FUNCTION <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
  RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
  [ [ NOT ] NULL ]
  LANGUAGE JAVASCRIPT
  [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
  [ VOLATILE | IMMUTABLE ]
  [ COMMENT = '<string_literal>' ]
  AS '<function_definition>'

Python-Handler

Verwenden Sie die folgende Syntax, wenn der Quellcode inline ist:

CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] FUNCTION [ IF NOT EXISTS ] <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
    RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
    [ [ NOT ] NULL ]
    LANGUAGE PYTHON
    RUNTIME_VERSION = <python_version>
    [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
    [ VOLATILE | IMMUTABLE ]
    [ COMMENT = '<string_literal>' ]
    [ IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] ) ]
    [ PACKAGES = ( '<package_name>[==<version>]' [ , ... ] ) ]
    HANDLER = '<function_name>'
    AS '<function_definition>'

Verwenden Sie die nachstehende Syntax, wenn Sie auf den Quellcode am Speicherort des Stagingbereichs verweisen:

CREATE [ OR REPLACE ] [ TEMP | TEMPORARY ] FUNCTION [ IF NOT EXISTS ] <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
    RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
    [ [ NOT ] NULL ]
    LANGUAGE PYTHON
    RUNTIME_VERSION = <python_version>
    [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
    [ VOLATILE | IMMUTABLE ]
    [ COMMENT = '<string_literal>' ]
    IMPORTS = ( '<stage_path_and_file_name_to_read>' [ , ... ] )
    [ PACKAGES = ( '<package_name>[==<version>]' [ , ... ] ) ]
    HANDLER = '<module_file_name>.<function_name>'

SQL-Handler

CREATE [ OR REPLACE ] [ SECURE ] FUNCTION <name> ( [ <arg_name> <arg_data_type> ] [ , ... ] )
  RETURNS { <result_data_type> | TABLE ( <col_name> <col_data_type> [ , ... ] ) }
  [ [ NOT ] NULL ]
  [ { CALLED ON NULL INPUT | { RETURNS NULL ON NULL INPUT | STRICT } } ]
  [ VOLATILE | IMMUTABLE ]
  [ COMMENT = '<string_literal>' ]
  AS '<function_definition>'

Erforderliche Parameter¶

Alle Sprachen

name ( [ arg_name arg_data_type ] [ , ... ] )

Gibt den Bezeichner (und optional ein oder mehrere Argumente/Eingaben) für die UDF an. Der Bezeichner muss für das Schema, in dem die UDF erstellt wird, nicht eindeutig sein, da UDFs durch ihren Namen und ihre Argumenttypen identifiziert und aufgelöst werden.

Der Bezeichner muss jedoch mit einem alphabetischen Zeichen beginnen und darf keine Leer- oder Sonderzeichen enthalten, es sei denn, die gesamte Bezeichnerzeichenfolge wird in doppelte Anführungszeichen gesetzt (z. B. "My object"). Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß-/Kleinschreibung zu beachten.

Weitere Details dazu finden Sie unter Anforderungen an Bezeichner.

RETURNS ...

Gibt die von der UDF zurückgegebenen Ergebnisse an, die den UDF-Typ bestimmen:

result_data_type: Erstellt eine skalare UDF, die einen Einzelwert mit dem angegebenen Datentyp zurückgibt.

TABLE ( col_name col_data_type , ... ): Erstellt eine tabellarische UDF, die Tabellen mit den angegebenen Tabellenspalten und Spaltentypen zurückgibt.

Bemerkung

Bei Java-UDFs muss result_data_type in der Spalte SQL Data Type der SQL-Java-Typzuordnungstabelle enthalten sein.

Bei Python-UDFs muss result_data_type in der Spalte SQL Data Type der SQL-Python-Typzuordnungstabelle enthalten sein.

AS function_definition

Definiert den Handler-Code, der beim Aufruf der UDF ausgeführt wird. Der Wert von function_definition muss der Quellcode in einer der Sprachen sein, die von Handlern unterstützt werden. Folgende Sprachen werden für den Code unterstützt:

Java Weitere Informationen dazu finden Sie unter Java-UDFs.
JavaScript Weitere Informationen dazu finden Sie unter JavaScript UDFs.
Python. Weitere Informationen dazu finden Sie unter Python UDFs.
SQL-Ausdruck. Weitere Informationen dazu finden Sie unter SQL-UDFs.

Weitere Details dazu finden Sie unter Nutzungshinweise (unter diesem Thema).

Bemerkung

Die AS-Klausel ist nicht erforderlich, wenn mit der IMPORTS-Klausel auf den UDF-Handler-Code im Stagingbereich verwiesen wird.

Java

LANGUAGE JAVA

Gibt an, dass der Code in der Sprache Java vorliegt.

RUNTIME_VERSION = java_jdk_version

Gibt die zu verwendende Java JDK-Laufzeitversion an. Folgende Java-Versionen werden unterstützt:

11.x

Wenn RUNTIME_VERSION nicht festgelegt ist, wird Java JDK 11 verwendet.

IMPORTS = (stage_path_and_file_name_to_read)

Der Speicherort (Stagingbereich), der Pfad und der Name der zu importierenden Datei(en).

Eine Datei kann eine JAR-Datei oder ein anderer Typ von Datei sein.

Wenn die Datei eine JAR-Datei ist, kann sie eine oder mehrere .class-Dateien und keine oder mehrere Ressourcendateien enthalten.

JNI (Java Native Interface) wird nicht unterstützt. Snowflake verbietet das Laden von Bibliotheken, die nativen Code (im Gegensatz zu Java-Bytecode) enthalten.

Java-UDFs können auch Nicht-JAR-Dateien lesen. Ein Beispiel finden Sie unter Lesen einer Datei mit einem Java-UDF-Handler.

Wenn Sie vorhaben, eine Datei (JAR-Datei oder eine andere Datei) in einen Stagingbereich zu kopieren, empfiehlt Snowflake die Verwendung eines benannten internen Stagingbereichs, da der PUT-Befehl das Kopieren von Dateien in benannte interne Stagingbereiche unterstützt und der PUT-Befehl normalerweise die einfachste Möglichkeit ist, eine JAR-Datei in einen Stagingbereich zu verschieben.

Externe Stagingbereiche sind erlaubt, werden aber von PUT nicht unterstützt.

Jede Datei in der IMPORTS-Klausel muss einen eindeutigen Namen haben, auch wenn sich die Dateien in verschiedenen Unterverzeichnissen oder verschiedenen Stagingbereichen befinden.

Wenn sowohl die IMPORTS- als auch die TARGET_PATH-Klausel vorhanden ist, muss sich der Dateiname in der TARGET_PATH-Klausel von jedem Dateinamen in der IMPORTS-Klausel unterscheiden, auch wenn sich die Dateien in verschiedenen Unterverzeichnissen oder verschiedenen Stagingbereichen befinden.

Snowflake gibt einen Fehler zurück, wenn TARGET_PATH mit einer vorhandenen Datei übereinstimmt. Sie können TARGET_PATH nicht verwenden, um eine vorhandene Datei zu überschreiben.

Für eine vorkompilierte Java-UDF ist die IMPORTS-Klausel erforderlich, da sie den Speicherort der JAR-Datei angibt, die die UDF enthält.

Für eine Inline-Java-UDF wird die IMPORTS-Klausel nur dann benötigt, wenn die Inline-Java-UDF auf andere Dateien, wie z. B. Bibliotheken oder Textdateien, zugreifen muss.

Bei Snowflake-Systempaketen, wie dem Snowpark-Paket, können Sie das Paket mit der PACKAGES-Klausel angeben, anstatt seine JAR-Datei mit IMPORTS zu spezifizieren. Wenn Sie dies tun, muss die JAR-Paketdatei nicht in einem IMPORTS-Wert enthalten sein.

Inline-Java

function_definition: Inline-Java-UDFs erfordern eine Funktionsdefinition.

JavaScript

LANGUAGE JAVASCRIPT: Gibt an, dass der Code in der Sprache JavaScript vorliegt.

Python

LANGUAGE PYTHON

Gibt an, dass der Code in der Sprache Python vorliegt.

RUNTIME_VERSION = python_version

Gibt die zu verwendende Python-Version an. Folgende Versionen von Python werden unterstützt:

3.8

IMPORTS = (stage_path_and_file_name_to_read)

Der Speicherort (Stagingbereich), der Pfad und der Name der zu importierenden Datei(en).

Eine Datei kann eine .py-Datei oder ein anderer Typ von Datei sein.

Python-UDFs können auch Nicht-Python-Dateien lesen, z. B. Textdateien. Ein Beispiel dazu finden Sie unter Lesen von Dateien mit einem UDF-Handler.

Wenn Sie vorhaben, eine Datei in einen Stagingbereich zu kopieren, empfiehlt Snowflake die Verwendung eines benannten internen Stagingbereichs, denn der PUT-Befehl unterstützt das Kopieren von Dateien in benannte interne Stagingbereiche und der PUT-Befehl ist normalerweise die einfachste Möglichkeit, eine Datei in einen Stagingbereich zu verschieben.

Externe Stagingbereiche sind erlaubt, werden aber von PUT nicht unterstützt.

Jede Datei in der IMPORTS-Klausel muss einen eindeutigen Namen haben, auch wenn sich die Dateien in verschiedenen Unterverzeichnissen oder verschiedenen Stagingbereichen befinden.

Wenn der Handler-Code in einem Stagingbereich gespeichert ist, müssen Sie die IMPORTS-Klausel verwenden, um den Speicherort des Handler-Codes anzugeben.

Für eine Inline-Python-UDF wird die IMPORTS-Klausel nur dann benötigt, wenn der UDF-Handler auf andere Dateien, wie Pakete oder Textdateien, zugreifen muss.

Für Pakete, die wie numpy im Snowflake-System integriert sind, müssen Sie nur die PACKAGES-Klausel angeben und können die Angabe der Quelle des Pakets mit IMPORTS-Wert weglassen.

HANDLER = handler_name

Der Name der Handler-Funktion oder -Klasse.

Wenn der Handler für eine skalare UDF ist, die einen nicht tabellarischen Wert zurückgibt, muss der Wert von HANDLER ein Funktionsname sein. Wenn der Handler-Code inline in der CREATE FUNCTION-Anweisung angegeben wird, können Sie den Funktionsnamen allein verwenden. Wenn der Handler-Code in einem Stagingbereich referenziert wird, muss dieser Wert mit dem Modulnamen in folgender Form qualifiziert werden: my_module.my_function.
Wenn der Handler für eine tabellarische UDF ist, muss der Wert von HANDLER der Name einer Handler-Klasse sein.

Optionale Parameter¶

Alle Sprachen

SECURE

Gibt an, dass die Funktion sicher ist. Weitere Informationen zu sicheren Funktionen finden Sie unter Sichere UDFs.

[ [ NOT ] NULL ]

Gibt an, ob die Funktion auch NULL-Werte oder nur NON-NULL-Werte zurückgeben kann. Der Standardwert ist NULL (d. h. die Funktion kann NULL zurückgeben).

Bemerkung

Derzeit wird die NOT NULL-Klausel bei SQL-UDFs nicht erzwungen. Als NOT NULL deklarierte SQL-UDFs können NULL-Werte zurückgeben. Snowflake empfiehlt, NOT NULL nicht für SQL-UDFs zu verwenden, es sei denn, der Code in der Funktion wurde geschrieben, um sicherzustellen, dass niemals NULL-Werte zurückgegeben werden.

CALLED ON NULL INPUT oder . RETURNS NULL ON NULL INPUT | STRICT

Gibt das Verhalten der UDF an, wenn sie mit Null-Eingaben aufgerufen wird. Im Gegensatz zu systemdefinierten Funktionen, die immer Null zurückgeben, wenn eine Eingabe Null ist, können UDFs Null-Eingaben verarbeiten und Nicht-Null-Werte zurückgeben, auch wenn eine Eingabe Null ist:

CALLED ON NULL INPUT ruft immer die UDF mit Null-Eingaben auf. Es liegt an der UDF, mit solchen Werten angemessen umzugehen.

RETURNS NULL ON NULL INPUT (oder sein Synonym STRICT) ruft UDF nicht auf, wenn eine Eingabe Null ist. Stattdessen wird immer ein Null-Wert für diese Zeile zurückgegeben. Beachten Sie, dass die UDF bei Nicht-Null-Eingaben immer noch Null zurückgeben kann.

Standard: CALLED ON NULL INPUT

VOLATILE | IMMUTABLE

Gibt das Verhalten der UDF bei der Rückgabe des Ergebnisses an:

VOLATILE: Die UDF kann für verschiedene Zeilen unterschiedliche Werte zurückgeben, auch bei gleicher Eingabe (z. B. aufgrund von Nichtdeterminismus und Statefullness).

IMMUTABLE: UDF geht davon aus, dass die Funktion, wenn sie mit den gleichen Eingabewerten aufgerufen wird, immer das gleiche Ergebnis liefert. Diese Garantie wird nicht geprüft. Die Angabe von IMMUTABLE für eine UDF, die unterschiedliche Werte für dieselbe Eingabe zurückgibt, führt zu einem undefinierten Verhalten.

Standard: VOLATILE

COMMENT = 'string_literal'

Gibt einen Kommentar für die UDF an, der in der Spalte DESCRIPTION in der Ausgabe SHOW FUNCTIONS und SHOW USER FUNCTIONS angezeigt wird.

Standard: user-defined function

Java

PACKAGES = (package_name_and_version)

Der Name und die Versionsnummer der Snowflake-Systempakete, die als Abhängigkeiten benötigt werden. Der Wert muss die Form package_name:version_number haben, wobei der Paketname package_name der Bezeichner snowflake_domain:package ist. Beachten Sie, dass Sie latest als Versionsnummer angeben können, sodass Snowflake die neueste auf dem System verfügbare Version verwendet.

Beispiel:

-- Use version 1.2.0 of the Snowpark package.
packages=('com.snowflake:snowpark:1.2.0')

-- Use the latest version of the Snowpark package.
packages=('com.snowflake:snowpark:latest')

Sie können die Liste der unterstützten Systempakete ermitteln, indem Sie in Snowflake den folgenden SQL-Befehl ausführen:

select * from information_schema.packages where language ='java';

Für eine Abhängigkeit, die Sie mit PACKAGES angeben, müssen Sie die zugehörige JAR-Datei nicht zusätzlich in einer IMPORTS-Klausel angeben.

Inline-Java

TARGET_PATH = stage_path_and_file_name_to_write

Die TARGET_PATH-Klausel gibt den Speicherort an, in den Snowflake den kompilierten Code (JAR-Datei) nach der Kompilierung des in function_definition angegebenen Quellcodes schreiben soll.

Wenn diese Klausel enthalten ist, sollte der Benutzer die JAR-Datei manuell entfernen, wenn sie nicht mehr benötigt wird (typischerweise, wenn die Java-UDF gelöscht wird).

Wenn diese Klausel weggelassen wird, kompiliert Snowflake den Quellcode jedes Mal neu, wenn der Code benötigt wird. Die JAR-Datei wird nicht dauerhaft gespeichert, und der Benutzer muss die JAR-Datei nicht bereinigen.

Python

PACKAGES = (package_name[==package_version])

Name und Versionsnummer der Pakete, die als Abhängigkeiten benötigt werden. Der Wert muss die Form package_name==version_number haben. Wenn Sie die Versionsnummer weglassen, verwendet Snowflake die aktuell im System verfügbare Paketversion.

Beispiel:

-- Use version 1.2.2 of the NumPy package.
packages=('numpy==1.2.2')

-- Use the latest version of the NumPy package.
packages=('numpy')

Sie können die Liste der unterstützten Systempakete ermitteln, indem Sie in Snowflake den folgenden SQL-Befehl ausführen:

select * from information_schema.packages where language ='python';

Weitere Informationen zu den enthaltenen Paketen finden Sie unter Verwenden von Drittanbieter-Paketen.

Nutzungshinweise¶

Alle Sprachen

function_definition hat Größenbeschränkungen. Die maximal zulässige Größe kann sich ändern.
Die Trennzeichen um function_definition können einfache Anführungszeichen oder doppelte Dollarzeichen sein.

Eine Verwendung von $$ als Trennzeichen vereinfacht das Schreiben von gespeicherten Prozeduren, die einfache Anführungszeichen enthalten.

Wenn als Trennzeichen für den Textköper der Funktion das einfache Anführungszeichen verwendet wird, müssen alle Anführungszeichen innerhalb von function_definition (z. B. Zeichenfolgenliterale) mit einfachen Anführungszeichen als Escape-Zeichen versehen werden.
Wenn Sie eine UDF in einer Maskierungsrichtlinie verwenden, müssen Sie sicherstellen, dass die Datentypen von Spalte, UDF und Maskierungsrichtlinie übereinstimmen. Weitere Informationen dazu finden Sie unter Benutzerdefinierte Funktionen in einer Maskierungsrichtlinie.
Metadaten:

Achtung

Kunden müssen sicherstellen, dass bei der Nutzung des Snowflake-Dienstes keine personenbezogenen Daten (außer für ein Objekt „Benutzer“), sensible Daten, exportkontrollierte Daten oder andere regulierte Daten als Metadaten eingegeben werden. Weitere Informationen dazu finden Sie unter Metadatenfelder in Snowflake.
CREATE OR REPLACE <Objekt>-Anweisungen sind atomar. Das heißt, wenn das Objekt ersetzt wird, werden die Löschung des alten Objekts und die Erstellung des neuen Objekts in einer einzigen Transaktion verarbeitet.

Java

In Java lassen primitive Datentypen keine NULL-Werte zu, sodass die Übergabe eines NULL-Wertes für ein Argument eines solchen Typs zu einem Fehler führt.
In der HANDLER-Klausel wird beim Methodennamen zwischen Groß- und Kleinschreibung unterschieden.
In den Klauseln IMPORTS und TARGET_PATH:
- Bei Paket-, Klassen- und Dateinamen wird Groß-/Kleinschreibung unterschieden.
- Bei Stagingbereichsnamen wird Groß-/Kleinschreibung nicht unterschieden.
Sie können die PACKAGES-Klausel verwenden, um Paketname und Versionsnummer für systemdefinierte Snowflake-Abhängigkeiten, wie z. B. die von Snowpark, anzugeben. Für andere Abhängigkeiten geben Sie die JAR-Abhängigkeitsdateien mit der Klausel IMPORTS an.
Snowflake validiert Folgendes:
- Die im HANDLER der CREATE FUNCTION-Anweisung angegebene JAR-Datei existiert und enthält die angegebene Klasse und Methode.
- Die in der UDF-Deklaration angegebenen Eingangs- und Ausgangstypen sind mit den Eingangs- und Ausgangstypen der Java-Methode kompatibel.
Die Validierung kann zur Erstellungszeit oder zur Ausführungszeit erfolgen.
- Wenn der Benutzer zum Zeitpunkt der Ausführung der CREATE FUNCTION-Anweisung mit einem aktiven Snowflake-Warehouse verbunden ist, wird die UDF zum Erstellungszeitpunkt validiert.
- Andernfalls wird die UDF erstellt, aber nicht sofort validiert, und Snowflake gibt die folgende Meldung zurück: Function <Name> created successfully, but could not be validated since there is no active warehouse.

JavaScript

Snowflake validiert JavaScript-Code nicht zum Zeitpunkt der UDF-Erstellung (d. h. die Erstellung der UDF ist erfolgreich, unabhängig davon, ob der Code gültig ist). Wenn der Code nicht gültig ist, werden bei Aufruf der UDF zur Abfragezeit Fehler zurückgegeben.

Python

In der HANDLER-Klausel wird beim Namen der Handler-Funktion zwischen Groß- und Kleinschreibung unterschieden.
Für die IMPORTS-Klausel gilt:
- Bei Dateinamen wird Groß-/Kleinschreibung unterschieden.
- Bei Stagingbereichsnamen wird Groß-/Kleinschreibung nicht unterschieden.
Sie können die PACKAGES-Klausel verwenden, um Paketname und Versionsnummer für systemdefinierte Snowflake-Abhängigkeiten, wie z. B. der von Snowpark, anzugeben. Für andere Abhängigkeiten geben Sie die Abhängigkeitsdateien mit der IMPORTS-Klausel an.
Snowflake validiert Folgendes:
- Die im HANDLER-Code der CREATE FUNCTION-Anweisung angegebene Funktion oder Klasse ist vorhanden.
- Die in der UDF-Deklaration angegebenen Eingangs- und Ausgangstypen sind mit den Eingangs- und Ausgangstypen des Handlers kompatibel.
Die Validierung kann zur Erstellungszeit oder zur Ausführungszeit erfolgen.
- Wenn der Benutzer zum Zeitpunkt der Ausführung der CREATE FUNCTION-Anweisung mit einem aktiven Snowflake-Warehouse verbunden ist, wird die UDF zum Erstellungszeitpunkt validiert.
- Andernfalls wird die UDF erstellt, aber nicht sofort validiert, und Snowflake gibt die folgende Meldung zurück: Function <Name> created successfully, but could not be validated since there is no active warehouse.

SQL

Derzeit wird die NOT NULL-Klausel bei SQL-UDFs nicht erzwungen.

Beispiele¶

Java

Hier ist ein grundlegendes Beispiel für eine CREATE FUNCTION-Inline-Anweisung:

create or replace function echo_varchar(x varchar)
returns varchar
language java
called on null input
handler='TestFunc.echoVarchar'
target_path='@~/testfunc.jar'
as
'class TestFunc {
  public static String echoVarchar(String x) {
    return x;
  }
}';

Hier ist ein einfaches Beispiel einer skalaren CREATE FUNCTION-Anweisung:

create function my_decrement_udf(i numeric(9, 0))
    returns numeric
    language java
    imports = ('@~/my_decrement_udf_package_dir/my_decrement_udf_jar.jar')
    handler = 'my_decrement_udf_package.my_decrement_udf_class.my_decrement_udf_method'
    ;

Weitere Beispiele für Java-UDFs finden Sie unter Beispiele.

JavaScript

Erstellen Sie eine JavaScript-UDF mit dem Namen js_factorial:

CREATE OR REPLACE FUNCTION js_factorial(d double)
  RETURNS double
  LANGUAGE JAVASCRIPT
  STRICT
  AS '
  if (D <= 0) {
    return 1;
  } else {
    var result = 1;
    for (var i = 2; i <= D; i++) {
      result = result * i;
    }
    return result;
  }
  ';

Python

Der folgende Beispielcode erstellt eine Funktion py_udf, deren Handler-Code als udf inline ist.

create or replace function py_udf()
  returns variant
  language python
  runtime_version = '3.8'
  packages = ('numpy','pandas','xgboost==1.5.0')
  handler = 'udf'
as $$
import numpy as np
import pandas as pd
import xgboost as xgb
def udf():
    return [np.__version__, pd.__version__, xgb.__version__]
$$;

Der folgende Beispielcode erstellt eine Funktion dream, deren Handler sich in der Datei sleepy.py im Stagingbereich @my_stage befindet.

create or replace function dream(i int)
  returns variant
  language python
  runtime_version = '3.8'
  handler = 'sleepy.snore'
  imports = ('@my_stage/sleepy.py')

SQL

Erstellen Sie eine einfache skalare SQL-UDF, die eine hart codierte Approximation der mathematischen Konstante Pi zurückgibt:

CREATE FUNCTION pi_udf()
  RETURNS FLOAT
  AS '3.141592654::FLOAT'
  ;

Erstellen Sie eine einfache SQL-Tabellen-UDF, die hartcodierte Werte zurückgibt:

CREATE FUNCTION simple_table_function ()
  RETURNS TABLE (x INTEGER, y INTEGER)
  AS
  $$
    SELECT 1, 2
    UNION ALL
    SELECT 3, 4
  $$
  ;

SELECT * FROM TABLE(simple_table_function());

Ausgabe:

SELECT * FROM TABLE(simple_table_function());
+---+---+
| X | Y |
|---+---|
| 1 | 2 |
| 3 | 4 |
+---+---+

Erstellen Sie eine UDF, die mehrere Parameter akzeptiert:

CREATE FUNCTION multiply1 (a number, b number)
  RETURNS number
  COMMENT='multiply two numbers'
  AS 'a * b';

Erstellen Sie eine SQL-Tabellen-UDF namens get_countries_for_user, die die Ergebnisse einer Abfrage zurückgibt:

CREATE OR REPLACE FUNCTION get_countries_for_user ( id number )
  RETURNS TABLE (country_code char, country_name varchar)
  AS 'select distinct c.country_code, c.country_name
      from user_addresses a, countries c
      where a.user_id = id
      and c.country_code = a.country_code';