Udostępnij przez


functions grupa poleceń

Note

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Grupa functions poleceń w interfejsie wiersza polecenia usługi Databricks umożliwia zarządzanie funkcjami zdefiniowanymi przez użytkownika (UDF) w katalogu Unity. Implementacja funkcji może być dowolnym wyrażeniem LUB zapytaniem SQL i może być wywoływana wszędzie tam, gdzie odwołanie do tabeli jest dozwolone w zapytaniu. W katalogu Unity funkcja znajduje się na tym samym poziomie co tabela, dlatego można się do niej odnosić w formie catalog_name.schema_name.function_name.

tworzenie funkcji databricks

Utwórz nową funkcję.

Important

To jest funkcja objęta programem eksperymentalnym.

Aby funkcja została utworzona, użytkownik musi mieć następujące uprawnienia:

- USE_CATALOG w katalogu nadrzędnym funkcji

  • USE_SCHEMA i CREATE_FUNCTION w schemacie nadrzędnym funkcji
databricks functions create [flags]

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania.

Flagi globalne

Examples

Poniższy przykład tworzy funkcję przy użyciu pliku JSON:

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

Poniższy przykład tworzy funkcję przy użyciu wbudowanego kodu 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"}'

usuwanie funkcji databricks

Usuń funkcję zgodną z podaną nazwą.

Aby usunięcie zakończyło się pomyślnie, użytkownik musi spełnić jeden z następujących warunków:

  • Jest właścicielem katalogu nadrzędnego funkcji
  • Jest właścicielem schematu, do którego należy funkcja, i posiada uprawnienie USE_CATALOG do katalogu, do którego ten schemat należy.
  • Jest właścicielem funkcji jako takiej i ma zarówno USE_CATALOG uprawnienia do katalogu nadrzędnego, jak i USE_SCHEMA uprawnienia do schematu nadrzędnego
databricks functions delete NAME [flags]

Arguments

NAME

    Pełna nazwa funkcji (w formie catalog_name.schema_name.function_name).

Opcje

--force

    Wymuś usunięcie, nawet jeśli funkcja nie jest pusta.

Flagi globalne

Examples

Poniższy przykład usuwa funkcję:

databricks functions delete my_catalog.my_schema.my_function

Poniższy przykład wymusza usunięcie funkcji:

databricks functions delete my_catalog.my_schema.my_function --force

pobierz funkcje Databricks

Pobierz funkcję z katalogu nadrzędnego i schematu.

Aby pobieranie powiodło się, użytkownik musi spełnić jedno z następujących wymagań:

  • Jest administratorem magazynu metadanych
  • Jest właścicielem katalogu nadrzędnego funkcji
  • USE_CATALOG Mieć uprawnienia do katalogu nadrzędnego funkcji i być właścicielem funkcji
  • Posiadać USE_CATALOG uprawnienie do katalogu nadrzędnego funkcji, USE_SCHEMA uprawnienie do schematu nadrzędnego funkcji, oraz EXECUTE uprawnienie do samej funkcji
databricks functions get NAME [flags]

Arguments

NAME

    Pełna nazwa funkcji (w formie catalog_name.schema_name.function_name).

Opcje

--include-browse

    Określa, czy uwzględnić funkcje w odpowiedzi, dla których główny może uzyskiwać dostęp tylko do selektywnych metadanych.

Flagi globalne

Examples

Poniższy przykład pobiera informacje o funkcji:

databricks functions get my_catalog.my_schema.my_function

Poniższy przykład zwraca funkcję z informacjami o przeglądaniu.

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

lista funkcji usługi databricks

Wyświetlanie listy funkcji w określonym wykazie nadrzędnym i schemacie.

Jeśli użytkownik jest administratorem magazynu metadanych, wszystkie funkcje są zwracane na liście danych wyjściowych. W przeciwnym razie użytkownik musi mieć USE_CATALOG uprawnienia do katalogu i USE_SCHEMA uprawnienia do schematu, a lista wyjściowa zawiera tylko funkcje, dla których użytkownik ma EXECUTE uprawnienia lub użytkownik jest właścicielem. Nie ma gwarancji, że istnieje określona kolejność elementów w tablicy.

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Nazwa katalogu nadrzędnego dla funkcji, które nas interesują.

SCHEMA_NAME

    Macierzysty schemat funkcji.

Opcje

--include-browse

    Określa, czy uwzględnić funkcje w odpowiedzi, dla których główny może uzyskiwać dostęp tylko do selektywnych metadanych.

--max-results int

    Maksymalna liczba funkcji do zwrócenia.

--page-token string

    Nieprzezroczysty token stronicowania, umożliwiający przejście do następnej strony na podstawie poprzedniego zapytania.

Flagi globalne

Examples

W poniższym przykładzie wymieniono wszystkie funkcje w wykazie i schemacie:

databricks functions list my_catalog my_schema

Poniższy przykład zawiera listę funkcji z maksymalnie 10 wynikami:

databricks functions list my_catalog my_schema --max-results 10

W poniższym przykładzie wymieniono następujące funkcje wraz z informacjami przeglądania:

databricks functions list my_catalog my_schema --include-browse

aktualizacja funkcji usługi databricks

Zaktualizuj funkcję zgodną z podaną nazwą.

Można zaktualizować tylko właściciela funkcji. Jeśli użytkownik nie jest administratorem magazynu metadanych, użytkownik musi być członkiem grupy, która jest nowym właścicielem funkcji. Użytkownik musi spełnić jeden z następujących warunków:

  • Jest administratorem magazynu metadanych
  • Jest właścicielem katalogu nadrzędnego funkcji
  • Jest właścicielem schematu nadrzędnego funkcji i ma USE_CATALOG uprawnienie do katalogu nadrzędnego
  • Jest właścicielem samej funkcji i ma USE_CATALOG uprawnienie do katalogu nadrzędnego, a także USE_SCHEMA uprawnienia do schematu nadrzędnego funkcji
databricks functions update NAME [flags]

Arguments

NAME

    Pełna nazwa funkcji (w formie catalog_name.schema_name.function_name).

Opcje

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania.

--owner string

    Nazwa użytkownika bieżącego właściciela funkcji.

Flagi globalne

Examples

Poniższy przykład aktualizuje właściciela funkcji:

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

Flagi globalne

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file struna

    Ciąg reprezentujący plik do zapisywania dzienników wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr.

--log-format formatowanie

    Format typu logu text lub json. Wartość domyślna to text.

--log-level struna

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Wartość domyślna to text.

-p, --profile struna

    Nazwa profilu pliku ~/.databrickscfg, którego użyć do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, zostanie użyty profil o nazwie DEFAULT .

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target struna

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia