Erstellen einer benutzerdefinierten Funktion¶

Erstellen Sie eine UDF, wenn:¶

1. Schreiben Sie Funktionslogik als Handler in einer von mehreren unterstützten Sprachen, darunter Python, Java und Scala.

2. Wählen Sie ein Tool oder ein API, um die Funktion mit dem von Ihnen geschriebenen Handler zu erstellen.

   Weitere Informationen dazu finden Sie unter Tools zum Erstellen von UDFs.

   SQL	Verwenden Sie SQL und schreiben Sie Logik in einer von mehreren Sprachen.
   Snowpark	Verwenden Sie die Snowpark-API für Java, Python oder Scala.
   Befehlszeile	Ausführen von CLI-Befehlen, um die Funktion zu erstellen.
   Python API	Ausführen von clientseitigen Python-Befehle, um die Funktion zu erstellen.
   REST	Stellen von Anfragen an eine RESTful API, um die Funktion zu erstellen.

3. Führen Sie die Funktion mit einem der verschiedenen Tools aus, je nach Ihren Bedürfnissen.

Tools zum Erstellen von UDFs¶

Sie können eine UDF mit einer von mehreren in Snowflake verfügbaren Methoden erstellen, je nachdem, welche Sprache und welche Fähigkeiten Sie haben. Wählen Sie aus der folgenden Tabelle das für Ihre Bedürfnisse geeignete Tool aus.

Wichtige Eigenschaften¶

Im Folgenden werden einige der Eigenschaften beschrieben, die beim Erstellen einer Funktion erforderlich sind oder üblicherweise verwendet werden.

Funktionsname:

Der Funktionsname muss nicht mit dem Namen des Handlers übereinstimmen. Für weitere Informationen zu Einschränkungen und Konventionen bei der Namensvergabe finden Sie unter Benennen und Überladen von Prozeduren und UDFs.

Argumente:

Weitere Informationen zu den Anforderungen finden Sie unter Definieren von Argumenten für UDFs und gespeicherte Prozeduren.

Rückgabetyp:

Weitere Informationen zum Zuordnen von SQL-Datentypen zu Handler-Datentypen in Snowflake finden Sie unter Zuordnung von Datentypen zwischen SQL und Handler-Sprachen.

Handler-Name:

Falls erforderlich, ist dies der Name der Klasse oder Methode, die den Code enthält, der bei Ausführung der Funktion ausgeführt wird. Die Angabe eines Handler-Namens ist nur für Handler erforderlich, die in Java, Python oder Scala geschrieben wurden. Bei JavaScript- und SQL-Handlern wird der gesamte Inline-Code als Handler ausgeführt.

Abhängigkeiten:

Bei einem in Java, Python oder Scala geschriebenen Handler müssen Sie möglicherweise auch die Snowpark-Bibliothek angeben, z. B. bei der Erstellung der Funktion.

Weitere Informationen zur Bereitstellung der Abhängigkeiten für den Handler finden Sie unter Abhängigkeiten für Code zur Verfügung stellen.

Laufzeit der Handler-Sprache:

Wenn die Handler-Sprache Java, Python oder Scala ist, geben Sie die Laufzeitversion an, um anzugeben, welche unterstützte Laufzeitversion verwendet werden soll. Denken Sie daran, dass sich die Standardversion im Laufe der Zeit ändern wird, wenn Sie sie verwenden.

Anforderungen an die Zugriffssteuerung¶

Eine Rolle, die zur Ausführung dieser Operation verwendet wird, muss mindestens die folgenden Berechtigungen haben:

USAGE-Berechtigung für die übergeordnete Datenbank und das Schema ist erforderlich, um Operationen an einem beliebigen Objekt in einem Schema durchzuführen.

Eine Anleitung zum Erstellen einer kundenspezifischen Rolle mit einer bestimmten Gruppe von Berechtigungen finden Sie unter Erstellen von kundenspezifischen Rollen.

Allgemeine Informationen zu Rollen und Berechtigungen zur Durchführung von SQL-Aktionen auf sicherungsfähigen Objekten finden Sie unter Übersicht zur Zugriffssteuerung.

Nutzungshinweise¶

Die folgenden Anmerkungen beschreiben die Nutzungshinweise für die Sprachen, die beim Schreiben von Handlern unterstützt werden. Obwohl sich die Hinweise in den folgenden Abschnitten auf Klauseln des SQL-Befehls CREATE FUNCTION beziehen, werden diese Klauseln in der Regel auf andere Weise in anderen Tools dargestellt, die Sie zum Erstellen von Funktionen verwenden können.

Eine UDF mit SQL erstellen¶

Sie können eine UDF mit SQL erstellen, indem Sie die folgenden Schritte ausführen.

Zum Erstellen einer UDF müssen Sie die folgenden Schritte ausführen:

1. Schreiben Sie den Handler-Code, der bei Aufruf der UDF ausgeführt werden soll.

   Sie können eine der unterstützten Handler-Sprachen verwenden. Weitere Informationen dazu finden Sie unter Unterstützte Sprachen und Tools.

2. Legen Sie fest, ob Sie den Handler-Code inline in der SQL-Anweisung CREATE FUNCTION verwenden möchten oder auf den Handler-Code in einem Stagingbereich verweisen möchten.

   Beide Methoden haben Vor- und Nachteile. Weitere Informationen dazu finden Sie unter Speichern von Handler-Code inline oder in einem Stagingbereich.

3. Führen Sie eine CREATE FUNCTION-Anweisung in SQL aus, und geben Sie dabei die Eigenschaften der Funktion an.

   Der Code im folgenden Beispiel erstellt eine UDF namens function_name mit dem Inline-Handler HandlerClass.handlerMethod.

   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

   Im Folgenden werden einige der Eigenschaften beschrieben, die beim Erstellen einer Funktion erforderlich sind oder üblicherweise verwendet werden.

   • Funktionsname.

     Der UDF-Name muss nicht mit dem Namen der in Java geschriebenen Handler-Methode übereinstimmen. Die CREATE FUNCTION-Anweisung verknüpft den UDF-Namen mit dem Handler.

     Für weitere Informationen zu Einschränkungen und Konventionen bei der Namensvergabe finden Sie unter Benennen und Überladen von Prozeduren und UDFs.

   • Funktionsargumente, falls vorhanden.

     Siehe Definieren von Argumenten für UDFs und gespeicherte Prozeduren.

   • Rückgabetyp mit der RETURNS-Klausel.

     Bei einem skalaren Rückgabewert gibt die RETURNS-Klausel einen einzelnen Rückgabetyp an. Bei einem tabellarischen Rückgabewert gibt RETURNS das Schlüsselwort TABLE an, das den Spaltentyp im tabellarischen Rückgabewert angibt.

     Weitere Informationen zum Zuordnen von SQL-Datentypen zu Handler-Datentypen in Snowflake finden Sie unter Benennen und Überladen von Prozeduren und UDFs.

   • Handler-Name mit der HANDLER-Klausel.

     Falls erforderlich, ist dies der Name der Klasse oder Methode, die den Code enthält, der bei Aufruf der UDF ausgeführt wird. Die Angabe eines Handler-Namens ist nur für Handler erforderlich, die in Java und Python geschrieben wurden. Bei JavaScript- und SQL-Handlern wird der gesamte Inline-Code als Handler ausgeführt.

     In der folgenden Tabelle wird gezeigt, welche Form der Wert der HANDLER-Klausel in Abhängigkeit von der Handler-Sprache und dem Funktionstyp annimmt.

     Sprache des Handlers	UDF	UDTF
     Java	Klassen- und Methodenname. Beispiel: MyClass.myMethod	Nur Klassenname. Der Name der Handler-Methode wird durch die erforderliche Schnittstelle vorgegeben.
     JavaScript	Keine.	Keine.
     Python	Klassen- und Methodenname bei Verwendung einer Klasse, ansonsten Funktionsname. Beispiel: module.my_function oder my_function	Nur Klassenname. Der Name der Handler-Methode wird durch die erforderliche Schnittstelle vorgegeben.
     SQL	Keine.	Keine.

   • Vom Handler benötigte Abhängigkeiten, falls vorhanden, unter Verwendung der IMPORTS- oder PACKAGES-Klausel.

     Weitere Informationen zur Bereitstellung der Abhängigkeiten für den Handler finden Sie unter Abhängigkeiten für Code zur Verfügung stellen.

   • Laufzeitumgebung der Handler-Sprache mit Klausel RUNTIME_VERSION.

     Wenn die Handler-Sprache Java oder Python ist, verwenden Sie die RUNTIME_VERSION-Klausel, um anzugeben, welche unterstützte Laufzeitversion verwendet werden soll. Wenn Sie die Klausel weglassen, verwendet Snowflake die Standardeinstellung, die sich in Zukunft ändern kann.