Erstellen eines Java-UDF-Handlers¶

Schreiben des UDF-Handlers in Java¶

Beachten Sie beim Schreiben eines Java-UDF-Handlers die folgenden Anforderungen und Richtlinien.

• Definieren Sie die Klasse als „public“.

• Deklarieren Sie innerhalb der Klasse mindestens eine öffentliche Methode, die als UDF-Handler verwendet werden soll.

  Bei einer Inline-UDF deklarieren Sie nur eine einzige Handler-Methode. Wenn Sie aber beabsichtigen, die Klasse in eine JAR-Datei zu packen und die Datei als Handler in einem Stagingbereich bereitzustellen, können Sie mehrere Handler-Methoden deklarieren und später jede mit der HANDLER-Klausel einer CREATE FUNCTION-Anweisung als Handler spezifizieren.

  Weitere Informationen zum Unterschied zwischen einem Inline-Handler und einem Staging-Handler finden Sie unter Speichern von Handler-Code inline oder in einem Stagingbereich.

  Sie können bei Bedarf weitere Methoden deklarieren, die von der Handler-Methode aufgerufen werden.

  Beachten Sie die folgenden Anforderungen und Richtlinien bei jeder Handler-Methode:

  • Deklarieren Sie die Handler-Methode als „public“ (öffentlich), entweder statisch oder nicht-statisch.

    Wenn die Methode nicht statisch ist, muss Ihre Klasse auch einen Konstruktor mit null Argumenten oder überhaupt keinen Konstruktor deklarieren.

    Snowflake übergibt beim Instanziieren der Klasse keine Argumente an den Konstruktor. Wenn der Konstruktor einen Fehler auslöst, wird dieser Fehler zusammen mit der Ausnahmemeldung als Benutzerfehler ausgelöst.

  • Geben Sie einen geeigneten Rückgabetyp an.

    Der Rückgabetyp muss einer der in der Spalte Java Data Type der SQL-Java-Typzuordnungstabelle angegebenen Datentypen sein. Der Rückgabetyp muss mit dem SQL-Datentyp kompatibel sein, der in der RETURNS-Klausel der CREATE FUNCTION-Anweisung angegeben ist.

  • Stellen Sie sicher, dass jedes Argument der Handler-Methode (falls vorhanden) ein Datentyp ist, der in der Spalte Java Data Type der SQL-Java-Typzuordnungstabelle angegeben ist.

    Berücksichtigen Sie bei der Auswahl der Datentypen von Java-Variablen die maximal und minimal möglichen Werte der Daten, die von Snowflake gesendet (und an Snowflake zurückgegeben) werden könnten.

  • Beim Überladen von Methodennamen ist zu beachten, dass Snowflake bei Java- und JavaScript-UDFs zur Unterscheidung der Handler-Methoden nur die Anzahl der Methodenargumente und nicht deren Typen verwendet. Das Auflösen auf Basis von Datentypen ist unpraktisch, da einige SQL-Datentypen mehr als einem Java-Datentyp und damit potenziell mehr als einer Handler-Methoden-Signatur zugeordnet werden können.

    Wenn beispielsweise zwei Java-Methoden den gleichen Namen und die gleiche Anzahl von Argumenten, aber unterschiedliche Datentypen haben, dann erzeugt der Aufruf einer UDF mit einer dieser Methoden als Handler einen Fehler, der in etwa wie folgt lautet:

    Kann nicht bestimmen, welche Implementierung von Handler „Handlername“ aufgerufen werden soll, da es mehrere Definitionen mit <Anzahl der Argumente> Argumenten in Funktion <Name der UDF> mit Handler <Klassenname>.<Handlername> gibt.

    Wenn ein Warehouse vorhanden ist, wird der Fehler zum Zeitpunkt der Erstellung der UDF erkannt. Andernfalls tritt der Fehler beim Aufruf der UDF auf.

    Beachten Sie, dass Snowflake bei SQL-UDFs sowohl die Anzahl der Argumente als auch deren Datentypen verwendet, um zwischen überladenen Funktionen zu unterscheiden.

  • Achten Sie bei jeder Handler-Methode und den von ihr aufgerufenen Methoden auf die Einhaltung der Snowflake-bedingten Einschränkungen für Java-UDFs. Weitere Informationen zu diesen Einschränkungen finden Sie unter Entwerfen von Handlern unter Berücksichtigung der Snowflake-bedingten Einschränkungen.

Hinzufügen von Abhängigkeiten zum Klassenpfad¶

Wenn Ihr Handler-Code Klassen benötigt, die in externen JAR-Dateien verpackt sind, können Sie diese Abhängigkeiten dem von Snowflake verwalteten Klassenpfad hinzufügen, der für Ihren Handler verfügbar ist. Im Folgenden wird beschrieben, wie JAR-Dateien dem Klassenpfad hinzufügt werden, der für einen Java-UDF Handler sichtbar ist. Weitere Informationen dazu finden Sie unter Abhängigkeiten für Code zur Verfügung stellen.

Organisieren Ihrer Dateien¶

Wenn Sie vorhaben, den Java-Code zu kompilieren, um die JAR-Datei selbst zu erstellen, können Sie die Dateien wie unten gezeigt organisieren. Dieses Beispiel geht davon aus, dass Sie den Package-Mechanismus von Java verwenden möchten.

• Entwicklungsverzeichnis

  • Paketverzeichnis

    • Klassendatei1.java

    • Klassendatei2.java

  • classDirectory

    • Klassendatei1.class

    • Klassendatei2.class

  • Manifestdatei.manifest (optional)

  • jar_Datei.jar

  • put_Befehl.sql

developmentDirectory

Dieses Verzeichnis enthält die projektspezifischen Dateien, die zum Erstellen Ihrer Java-UDF erforderlich sind.

packageDirectory

Dieses Verzeichnis enthält die .java-Dateien, die kompiliert und in das Paket aufgenommen werden sollen.

class_file#.java

Diese Dateien enthalten den Java-Quellcode der UDF.

class_file#.class

Dies sind die .class-Dateien, die durch Kompilieren der .java-Dateien erstellt werden.

manifest_file.manifest

Die optionale Manifestdatei, die beim Kombinieren der .class-Dateien (und optional der Abhängigkeits-JAR-Dateien) in der JAR-Datei verwendet werden.

jar_file.jar

Die JAR-Datei, die den UDF-Code enthält.

put_command.sql

Diese Datei enthält den SQL-Befehl PUT zum Kopieren der JAR-Datei in einen Snowflake-Stagingbereich.