Grupo de comandos functions

O functions grupo de comandos dentro da CLI do Databricks permite que você gerencie UDFs (funções definidas pelo usuário) no Catálogo do Unity. 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 Catálogo do Unity, uma função reside no mesmo nível de uma tabela, para que possa ser referenciada com o formulário catalog_name.schema_name.function_name.

criar funções no databricks

Crie uma nova função.

O usuário deve 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 pai da função

databricks functions create [flags]

Opções

--json JSON

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

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

exclusão de funções do databricks

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 no seu catálogo principal.
• É o proprietário da função e tem tanto o privilégio USE_CATALOG no catálogo principal quanto o privilégio USE_SCHEMA no esquema principal

databricks functions delete NAME [flags]

Arguments

NAME

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

Opções

--force

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

Sinalizadores 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

Obter funções do Databricks

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

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

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

databricks functions get NAME [flags]

Arguments

NAME

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

Opções

--include-browse

    Indica se deve incluir na resposta as funções para as quais a entidade de segurança tem acesso apenas a metadados seletivos.

Sinalizadores 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 do databricks

Liste funções dentro do catálogo principal e o esquema especificados.

Se o usuário for um administrador do metastore, todas as funções serão retornadas na lista de saída. Caso contrário, o usuário deverá ter o privilégio USE_CATALOG no catálogo e o privilégio USE_SCHEMA no esquema, e a lista de saída conterá apenas funções para as quais o usuário tenha o privilégio EXECUTE ou seja o proprietário. 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

    Esquema principal de funções.

Opções

--include-browse

    Indica se deve incluir na resposta as funções para as quais a entidade de segurança tem acesso apenas a metadados seletivos.

--max-results int

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

--page-token string

    Token de paginação não transparente que permite ir para a próxima página com base na consulta anterior.

Sinalizadores 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 de funções do databricks

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

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

• É um administrador do 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 no seu catálogo principal.
• É o proprietário da função e tem o privilégio USE_CATALOG no catálogo principal, bem como o privilégio USE_SCHEMA no esquema principal da função

databricks functions update NAME [flags]

Arguments

NAME

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

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha 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.

Sinalizadores 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

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

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

--log-file corda

    Uma cadeia de caracteres que representa o arquivo para o qual gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    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á desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

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

--progress-format formato

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

-t, --target corda

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