functions Befehlsgruppe

Note

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Mit functions der Befehlsgruppe in der Databricks CLI können Sie benutzerdefinierte Funktionen (UDFs) im Unity-Katalog verwalten. Die Funktionsimplementierung kann ein beliebiger SQL-Ausdruck oder eine beliebige Abfrage sein und kann aufgerufen werden, wo ein Tabellenverweis in einer Abfrage zulässig ist. Im Unity-Katalog befindet sich eine Funktion auf derselben Ebene wie eine Tabelle, sodass sie mit dem Formular catalog_name.schema_name.function_namereferenziert werden kann.

Databricks-Funktionen erstellen

Erstellen Sie eine neue Funktion.

Important

Dies ist eine Funktion, die in Prüfung ist.

Der Benutzer muss über die folgenden Berechtigungen verfügen, damit die Funktion erstellt werden kann:

- USE_CATALOG auf den übergeordneten Katalog der Funktion

• USE_SCHEMA und CREATE_FUNCTION im übergeordneten Schema der Funktion

databricks functions create [flags]

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine Funktion mithilfe einer JSON-Datei erstellt:

databricks functions create --json @function-definition.json

Im folgenden Beispiel wird eine Funktion mithilfe von Inline-JSON erstellt:

databricks functions create --json '{"name": "my_catalog.my_schema.my_function", "data_type": "INT", "full_data_type": "INT", "return_params": {"parameters": []}, "routine_body": "SQL", "routine_definition": "SELECT 1", "routine_dependencies": {"dependencies": []}, "parameter_style": "S", "is_deterministic": true, "sql_data_access": "CONTAINS_SQL", "is_null_call": false, "security_type": "DEFINER", "specific_name": "my_function"}'

Databricks-Funktionen löschen

Löschen Sie die Funktion, die dem angegebenen Namen entspricht.

Damit der Löschvorgang erfolgreich ist, muss der Benutzer eine der folgenden Bedingungen erfüllen:

• Ist der Besitzer des übergeordneten Katalogs der Funktion
• Ist der Besitzer des übergeordneten Schemas der Funktion und hat die Berechtigung USE_CATALOG auf den übergeordneten Katalog
• Ist der Besitzer der Funktion selbst und hat sowohl das USE_CATALOG-Recht auf den übergeordneten Katalog als auch das USE_SCHEMA-Recht auf das übergeordnete Schema

databricks functions delete NAME [flags]

Arguments

NAME

    Der vollqualifizierte Name der Funktion (des Formulars catalog_name.schema_name.function_name).

Options

--force

    Löschung erzwingen, auch wenn die Funktion nicht leer ist.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird eine Funktion gelöscht:

databricks functions delete my_catalog.my_schema.my_function

Im folgenden Beispiel wird das Löschen einer Funktion erzwungen:

databricks functions delete my_catalog.my_schema.my_function --force

databricks-Funktionen abrufen

Dient zum Abrufen einer Funktion innerhalb eines übergeordneten Katalogs und Schemas.

Damit der Abruf erfolgreich ist, muss der Benutzer eine der folgenden Anforderungen erfüllen:

• Ist ein Metastore-Administrator
• Ist Besitzer des übergeordneten Katalogs der Funktion
• Sie haben das USE_CATALOG-Recht auf den übergeordneten Katalog der Funktion und sind Besitzer der Funktion
• Sie haben das USE_CATALOG-Recht auf den übergeordneten Katalog der Funktion, das USE_SCHEMA-Recht auf das übergeordnete Schema der Funktion und das EXECUTE-Recht auf die Funktion selbst

databricks functions get NAME [flags]

Arguments

NAME

    Der vollqualifizierte Name der Funktion (des Formulars catalog_name.schema_name.function_name).

Options

--include-browse

    ob Funktionen in die Antwort aufgenommen werden sollen, für die der Prinzipal nur selektiv auf Metadaten zugreifen kann.

Globale Kennzeichnungen

Examples

Das folgende Beispiel ruft Informationen zu einer Funktion ab:

databricks functions get my_catalog.my_schema.my_function

Im folgenden Beispiel wird eine Funktion mit enthaltenen Suchinformationen dargestellt:

databricks functions get my_catalog.my_schema.my_function --include-browse

Liste der Databricks-Funktionen

Funktionen innerhalb des angegebenen übergeordneten Katalogs und Schemas auflisten.

Wenn der Benutzer ein Metastore-Administrator ist, werden alle Funktionen in der Ausgabeliste zurückgegeben. Andernfalls muss der Benutzer über die USE_CATALOG Berechtigungen für den Katalog und die USE_SCHEMA Berechtigungen für das Schema verfügen, und die Ausgabeliste enthält nur Funktionen, für die der Benutzer über die EXECUTE Berechtigung verfügt oder der Benutzer der Besitzer ist. Es gibt keine Garantie für eine bestimmte Reihenfolge der Elemente im Array.

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Name des übergeordneten Katalogs für Funktionen von Interesse.

SCHEMA_NAME

    Übergeordnetes Schema der Funktionen.

Options

--include-browse

    ob Funktionen in die Antwort aufgenommen werden sollen, für die der Prinzipal nur selektiv auf Metadaten zugreifen kann.

--max-results int

    Maximale Anzahl von Funktionen, die zurückgegeben werden sollen.

--page-token string

    Intransparentes Token für die Paginierung, um auf der Grundlage der vorherigen Abfrage zur nächsten Seite zu gelangen.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel werden alle Funktionen in einem Katalog und Schema aufgelistet:

databricks functions list my_catalog my_schema

Im folgenden Beispiel werden Funktionen mit maximal 10 Ergebnissen aufgelistet:

databricks functions list my_catalog my_schema --max-results 10

Das folgende Beispiel listet Funktionen mit eingeschlossenen Suchinformationen auf:

databricks functions list my_catalog my_schema --include-browse

Databricks-Funktionen aktualisieren

Aktualisieren Sie die Funktion, die dem angegebenen Namen entspricht.

Nur der Besitzer der Funktion kann aktualisiert werden. Wenn der Benutzer kein Metastore-Administrator ist, muss der Benutzer Mitglied der Gruppe sein, die der neue Funktionsbesitzer ist. Der Benutzer muss eine der folgenden Bedingungen erfüllen:

• Ist ein Metastore-Administrator
• Ist der Besitzer des übergeordneten Katalogs der Funktion
• Ist der Besitzer des übergeordneten Schemas der Funktion und hat die Berechtigung USE_CATALOG auf den übergeordneten Katalog
• Ist der Besitzer der Funktion selbst und hat das USE_CATALOG-Recht auf ihren übergeordneten Katalog sowie das USE_SCHEMA-Recht auf das übergeordnete Schema der Funktion

databricks functions update NAME [flags]

Arguments

NAME

    Der vollqualifizierte Name der Funktion (des Formulars catalog_name.schema_name.function_name).

Options

--json JSON

    Die inlinefähige JSON-Zeichenfolge oder die @path zur JSON-Datei mit dem Body der Anfrage.

--owner string

    Benutzername des aktuellen Funktionsbesitzers.

Globale Kennzeichnungen

Examples

Im folgenden Beispiel wird der Besitzer einer Funktion aktualisiert:

databricks functions update my_catalog.my_schema.my_function --owner someone@example.com

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel