Partilhar via


functions grupo de comando

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Pré-Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

O functions grupo de comandos dentro da CLI Databricks permite-lhe gerir funções definidas pelo utilizador (UDFs) no Unity Catalog. A implementação da função pode ser qualquer expressão ou consulta SQL e pode ser invocada sempre que uma referência de tabela for permitida em uma consulta. No Unity Catalog, uma função reside no mesmo nível de uma tabela, portanto, pode ser referenciada com o formulário catalog_name.schema_name.function_name.

Funções Databricks Criar

Crie uma nova função.

Important

Esta é uma funcionalidade experimental.

O usuário deve ter as seguintes permissões para que a função seja criada:

- USE_CATALOG no catálogo de origem da função

  • USE_SCHEMA e CREATE_FUNCTION no esquema pai da função
databricks functions create [flags]

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Examples

O exemplo a seguir cria uma função usando um arquivo JSON:

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

O exemplo a seguir cria uma função usando JSON embutido:

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"}'

Excluir funções do Databricks

Exclua a função que corresponde ao nome fornecido.

Para que a eliminação seja bem-sucedida, o utilizador deve satisfazer uma das seguintes condições:

  • É o proprietário do catálogo pai da função
  • É o proprietário do esquema pai da função e tem o USE_CATALOG privilégio em seu catálogo pai
  • É o proprietário da função em si e tem ambos os USE_CATALOG privilégio no seu catálogo principal e USE_SCHEMA privilégio no seu esquema principal
databricks functions delete NAME [flags]

Arguments

NAME

    O nome completo da função (no formato catalog_name.schema_name.function_name).

Opções

--force

    Força a eliminação mesmo que a função não esteja vazia.

Bandeiras globais

Examples

O exemplo a seguir exclui uma função:

databricks functions delete my_catalog.my_schema.my_function

O exemplo a seguir força a exclusão de uma função:

databricks functions delete my_catalog.my_schema.my_function --force

Acesso às funções do Databricks

Obtenha uma função de dentro de um catálogo pai e esquema.

Para que a busca seja bem-sucedida, o usuário deve satisfazer um dos seguintes requisitos:

  • É um administrador de metastore
  • É o proprietário do catálogo de origem da função
  • Ter o privilégio USE_CATALOG no catálogo pai da função e ser o proprietário da função
  • Ter o privilégio de USE_CATALOG no catálogo pai da função, o privilégio de USE_SCHEMA no esquema pai da função e o privilégio de EXECUTE na própria função
databricks functions get NAME [flags]

Arguments

NAME

    O nome completo da função (no formato catalog_name.schema_name.function_name).

Opções

--include-browse

    Se as funções devem ser incluídas na resposta para as quais o principal só pode acessar metadados seletivos.

Bandeiras globais

Examples

O exemplo a seguir obtém informações sobre uma função:

databricks functions get my_catalog.my_schema.my_function

O exemplo a seguir obtém uma função com informações de navegação incluídas:

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

Lista de funções Databricks

Listar funções no catálogo pai e no esquema especificado.

Se o usuário for um administrador de metastore, todas as funções serão retornadas na lista de saída. Caso contrário, o utilizador deve ter o USE_CATALOG privilégio no catálogo e o USE_SCHEMA privilégio no esquema, e a lista de saída contém apenas funções para as quais o utilizador detém o EXECUTE privilégio ou é o dono. Não há garantia de uma ordenação específica dos elementos na matriz.

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Nome do catálogo principal para funções de interesse.

SCHEMA_NAME

    Modelo principal de funções.

Opções

--include-browse

    Se as funções devem ser incluídas na resposta para as quais o principal só pode acessar metadados seletivos.

--max-results int

    Número máximo de funções a devolver.

--page-token string

    Token de paginação opaco para avançar para a próxima página com base na consulta anterior.

Bandeiras globais

Examples

O exemplo a seguir lista todas as funções em um catálogo e esquema:

databricks functions list my_catalog my_schema

O exemplo a seguir lista funções com um máximo de 10 resultados:

databricks functions list my_catalog my_schema --max-results 10

O exemplo a seguir lista funções com informações de navegação incluídas:

databricks functions list my_catalog my_schema --include-browse

Atualização das funções do Databricks

Atualize a função que corresponde ao nome fornecido.

Apenas é possível atualizar o dono da função. Se o usuário não for um administrador de metastore, deverá ser membro do grupo que é o novo proprietário da função. O utilizador deve satisfazer uma das seguintes condições:

  • É um administrador de metastore
  • É o proprietário do catálogo pai da função
  • É o proprietário do esquema ao qual a função pertence e tem o USE_CATALOG privilégio no catálogo pai da função.
  • É o proprietário da própria função e tem o privilégio USE_CATALOG no seu catálogo pai, bem como o privilégio USE_SCHEMA no esquema pai da função.
databricks functions update NAME [flags]

Arguments

NAME

    O nome completo da função (no formato catalog_name.schema_name.function_name).

Opções

--json JSON

    A cadeia de caracteres JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--owner string

    Nome de usuário do proprietário atual da função.

Bandeiras globais

Examples

O exemplo a seguir atualiza o proprietário de uma função:

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

Bandeiras globais

--debug

  Se o log de depuração deve ser habilitado.

-h ou --help

    Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

    Uma cadeia de caracteres que representa o ficheiro onde os registos de saída são gravados. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no stderr.

--log-format Formato

    O tipo de formato de log, text ou json. O valor predefinido é text.

--log-level string

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor predefinido é text.

-p, --profile string

    O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se esse sinalizador não for especificado, se ele existir, o perfil nomeado DEFAULT será usado.

--progress-format Formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target string

    Se aplicável, o destino do pacote a ser usado