functions grupo de comando

nota

Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.

O grupo de comandos functions dentro do Databricks CLI permite gerenciar funções definidas pelo usuário (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 à tabela for permitida em uma consulta. Em Unity Catalog, uma função reside no mesmo nível que uma tabela, portanto, pode ser referenciada com o formato catalog_name.schema_name.function_name.

funções de databricks criam

Crie uma nova função.

important

Este é um recurso experimental.

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

-USE_CATALOG no catálogo principal da função

• USE_SCHEMA e CREATE_FUNCTION no esquema principal da função

databricks functions create [flags]

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Exemplos

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

Bash

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

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

Bash

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

funções do databricks excluir

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

Para que a exclusão seja bem-sucedida, o usuário deve atender a uma das seguintes condições:

• É o proprietário do catálogo principal da função
• É o proprietário do esquema principal da função e tem o privilégio USE_CATALOG em seu catálogo principal
• É o proprietário da função em si e tem o privilégio USE_CATALOG em seu catálogo principal e o privilégio USE_SCHEMA em seu esquema pai

databricks functions delete NAME [flags]

Argumentos

NAME

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

Opções

--force

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

Bandeiras globais

Exemplos

O exemplo a seguir exclui uma função:

Bash

databricks functions delete my_catalog.my_schema.my_function

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

Bash

databricks functions delete my_catalog.my_schema.my_function --force

funções de databricks get

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

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

• É administrador da metastore
• É proprietário do catálogo principal da função
• Tenha o privilégio USE_CATALOG no catálogo principal da função e seja o proprietário da função
• Tenha o privilégio USE_CATALOG no catálogo principal da função, o privilégio USE_SCHEMA no esquema principal da função e o privilégio EXECUTE na própria função

databricks functions get NAME [flags]

Argumentos

NAME

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

Opções

--include-browse

Se deve incluir funções na resposta para as quais o diretor só pode acessar metadados seletivos.

Bandeiras globais

Exemplos

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

Bash

databricks functions get my_catalog.my_schema.my_function

O exemplo a seguir obtém uma função com a informação browse incluída:

Bash

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

lista de funções do databricks

Listar funções dentro do catálogo e esquema principais especificados.

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

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Argumentos

CATALOG_NAME

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

SCHEMA_NAME

Esquema principal de funções.

Opções

--include-browse

Se deve incluir funções na resposta para as quais o diretor só pode acessar metadados seletivos.

--max-results int

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

--page-token string

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

Bandeiras globais

Exemplos

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

Bash

databricks functions list my_catalog my_schema

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

Bash

databricks functions list my_catalog my_schema --max-results 10

O exemplo a seguir lista funções com a informação browse incluída:

Bash

databricks functions list my_catalog my_schema --include-browse

atualização de funções do databricks

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

Somente o proprietário da função pode ser atualizado. Se o usuário não for administrador da metastore, ele deverá ser membro do grupo que é o novo proprietário da função. O usuário deve satisfazer uma das seguintes condições:

• É administrador da metastore
• É o proprietário do catálogo principal da função
• É o proprietário do esquema principal da função e tem o privilégio USE_CATALOG em seu catálogo principal
• É o proprietário da função em si e tem o privilégio USE_CATALOG em seu catálogo principal, bem como o privilégio USE_SCHEMA no esquema principal da função

databricks functions update NAME [flags]

Argumentos

NAME

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

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

--owner string

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

Bandeiras globais

Exemplos

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

Bash

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

Bandeiras globais

--debug

Se deve habilitar o registro de depuração.

-h ou --help

Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.

--log-format Formato

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

--log-level string

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

-o, --output Tipo

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

-p, --profile string

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

--progress-format Formato

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

-t, --target string

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