Not
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Note
Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.
Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.
Med functions kommandogruppen i Databricks CLI kan du hantera användardefinierade funktioner (UDF:er) i Unity Catalog. Funktionsimplementeringen kan vara valfritt SQL-uttryck eller en fråga, och den kan anropas där en tabellreferens tillåts i en fråga. I Unity Catalog finns en funktion på samma nivå som en tabell, så den kan refereras till med formuläret catalog_name.schema_name.function_name.
Skapa funktioner i Databricks
Skapa en ny funktion.
Important
Det här är en experimentell funktion.
Användaren måste ha följande behörigheter för att funktionen ska kunna skapas:
-
USE_CATALOG i funktionens överordnade katalog
-
USE_SCHEMAochCREATE_FUNCTIONpå funktionens överordnade schema
databricks functions create [flags]
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
Examples
I följande exempel skapas en funktion med hjälp av en JSON-fil:
databricks functions create --json @function-definition.json
I följande exempel skapas en funktion som använder inline JSON.
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-funktioner tas bort
Ta bort funktionen som matchar det angivna namnet.
För att borttagningen ska lyckas måste användaren uppfylla något av följande villkor:
- Är ägaren till funktionens överordnade katalog
- Är ägaren av funktionens överordnade schema och har
USE_CATALOG-behörigheten på dess överordnade katalog - Är ägaren av själva funktionen och har både privilegiet på
USE_CATALOGden överordnade katalogen och privilegiet påUSE_SCHEMAdess överordnade schema
databricks functions delete NAME [flags]
Arguments
NAME
Det fullständigt kvalificerade namnet på funktionen (i formuläret catalog_name.schema_name.function_name).
Options
--force
Framtvinga borttagning även om funktionen är notempty.
Examples
I följande exempel tas en funktion bort:
databricks functions delete my_catalog.my_schema.my_function
I följande exempel framtvingas borttagning av en funktion:
databricks functions delete my_catalog.my_schema.my_function --force
databricks-funktioner hämta
Hämta en funktion från en överordnad katalog och ett schema.
För att hämtningen ska lyckas måste användaren uppfylla något av följande krav:
- Är metaarkivadministratör
- Är ägare till funktionens huvudkatalog
- Ha behörighet på
USE_CATALOGfunktionens överordnade katalog och vara ägare till funktionen - Ha behörigheten
USE_CATALOGför funktionens överordnade katalog, behörighetenUSE_SCHEMAför funktionens överordnade schema och behörighetenEXECUTEför själva funktionen
databricks functions get NAME [flags]
Arguments
NAME
Det fullständigt kvalificerade namnet på funktionen (i formuläret catalog_name.schema_name.function_name).
Options
--include-browse
Om du vill inkludera funktioner i svaret som användaren endast har selektiv åtkomst till metadata för.
Examples
I följande exempel hämtas information om en funktion:
databricks functions get my_catalog.my_schema.my_function
I följande exempel hämtas en funktion med bläddringsinformation inkluderat:
databricks functions get my_catalog.my_schema.my_function --include-browse
databricks-funktionslista
Visa en lista över funktioner i den angivna överordnade katalogen och schemat.
Om användaren är metaarkivadministratör returneras alla funktioner i utdatalistan. Annars måste användaren ha behörigheten USE_CATALOG för katalogen och behörigheten USE_SCHEMA för schemat, och utdatalistan innehåller endast funktioner som användaren har behörighet för EXECUTE eller som användaren är ägare till. Det finns ingen garanti för en specifik ordning på elementen i matrisen.
databricks functions list CATALOG_NAME SCHEMA_NAME [flags]
Arguments
CATALOG_NAME
Namn på överordnad katalog för intressanta funktioner.
SCHEMA_NAME
Överordnat schema för funktioner.
Options
--include-browse
Om du vill inkludera funktioner i svaret som användaren endast har selektiv åtkomst till metadata för.
--max-results int
Maximalt antal funktioner som ska returneras.
--page-token string
Ogenomskinlig sidnumreringstoken för att gå till nästa sida baserat på föregående fråga.
Examples
I följande exempel visas alla funktioner i en katalog och ett schema:
databricks functions list my_catalog my_schema
I följande exempel visas funktioner med högst 10 resultat:
databricks functions list my_catalog my_schema --max-results 10
I följande exempel visas funktioner med sökinformation inkluderad:
databricks functions list my_catalog my_schema --include-browse
uppdatering av databricks-funktioner
Uppdatera funktionen som matchar det angivna namnet.
Endast funktionens ägare kan uppdateras. Om användaren inte är metaarkivadministratör måste användaren vara medlem i den grupp som är den nya funktionsägaren. Användaren måste uppfylla något av följande villkor:
- Är metaarkivadministratör
- Är ägaren till funktionens överordnade katalog
- Är ägaren till funktionens överordnade schema och har
USE_CATALOG-privilegiet på dess överordnade katalog - Är själva funktionens ägare och har behörigheten
USE_CATALOGpå den överordnade katalogen samt behörighetenUSE_SCHEMAför funktionens överordnade schema
databricks functions update NAME [flags]
Arguments
NAME
Det fullständigt kvalificerade namnet på funktionen (i formuläret catalog_name.schema_name.function_name).
Options
--json JSON
Den inbäddade JSON-strängen eller @path till JSON-filen med begärandekroppen.
--owner string
Användarnamn för aktuell funktionsägare.
Examples
Följande exempel uppdaterar en funktions ägare:
databricks functions update my_catalog.my_schema.my_function --owner someone@example.com
Globala flaggor
--debug
Om felsökningsloggning ska aktiveras.
-h eller --help
Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.
--log-file sträng
En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.
--log-format format
Loggformattypen, text eller json. Standardvärdet är text.
--log-level sträng
En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.
-o, --output typ
Kommandots utdatatyp, text eller json. Standardvärdet är text.
-p, --profile sträng
Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.
--progress-format format
Formatet för att visa förloppsloggar: default, append, inplaceeller json
-t, --target sträng
Om tillämpligt, paketmålet som ska användas