functions gruppo di comandi

Note

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il functions gruppo di comandi all'interno della Databricks CLI consente di gestire funzioni definite dall'utente (UDF) nel Unity Catalog. L'implementazione della funzione può essere qualsiasi espressione o query SQL e può essere richiamata ovunque sia consentito un riferimento a una tabella in una query. Nel catalogo Unity una funzione si trova allo stesso livello di una tabella, in modo che possa essere fatto riferimento al formato catalog_name.schema_name.function_name.

Creare funzioni in Databricks

Creare una nuova funzione.

Important

Si tratta di una funzionalità sperimentale.

Per creare la funzione, l'utente deve disporre delle autorizzazioni seguenti:

- USE_CATALOG nel catalogo padre della funzione

• USE_SCHEMA e CREATE_FUNCTION nello schema padre della funzione

databricks functions create [flags]

Options

--json JSON

    Stringa JSON inline o file JSON @path con il corpo della richiesta.

Flag globali

Examples

L'esempio seguente crea una funzione usando un file JSON:

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

L'esempio seguente crea una funzione usando JSON inline:

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

Elimina le funzioni di Databricks

Eliminare la funzione che corrisponde al nome specificato.

Affinché l'eliminazione abbia esito positivo, l'utente deve soddisfare una delle condizioni seguenti:

• È il proprietario del catalogo padre della funzione
• Proprietario dello schema padre della funzione e ha il privilegio sul USE_CATALOG catalogo padre
• È il proprietario della funzione stessa e ha entrambi i privilegi sul USE_CATALOG catalogo padre e il privilegio sul USE_SCHEMA schema padre

databricks functions delete NAME [flags]

Arguments

NAME

    Nome completo della funzione (del formato catalog_name.schema_name.function_name).

Options

--force

    Forzare l'eliminazione anche se la funzione non è vuota.

Flag globali

Examples

Nell'esempio seguente viene eliminata una funzione :

databricks functions delete my_catalog.my_schema.my_function

Nell'esempio seguente viene forzata l'eliminazione di una funzione:

databricks functions delete my_catalog.my_schema.my_function --force

Funzioni di databricks get

Ottenere una funzione da un catalogo principale e uno schema.

Affinché il recupero abbia esito positivo, l'utente deve soddisfare uno dei requisiti seguenti:

• Amministratore del metastore
• È un proprietario del catalogo superiore della funzione
• Avere il USE_CATALOG privilegio nel catalogo padre della funzione ed essere il proprietario della funzione
• Avere il USE_CATALOG privilegio per il catalogo padre della funzione, il USE_SCHEMA privilegio per lo schema padre della funzione e il EXECUTE privilegio sulla funzione stessa

databricks functions get NAME [flags]

Arguments

NAME

    Nome completo della funzione (del formato catalog_name.schema_name.function_name).

Options

--include-browse

    Indica se includere funzioni nella risposta per cui il principale può accedere solo ai metadati selezionati.

Flag globali

Examples

L'esempio seguente ottiene informazioni su una funzione:

databricks functions get my_catalog.my_schema.my_function

L'esempio seguente ottiene una funzione comprese le informazioni di navigazione:

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

elenco di funzioni di databricks

Elencare le funzioni all'interno del catalogo padre e dello schema specificati.

Se l'utente è un amministratore del metastore, tutte le funzioni vengono restituite nell'elenco di output. In caso contrario, l'utente deve avere il USE_CATALOG privilegio per il catalogo e il USE_SCHEMA privilegio per lo schema e l'elenco di output contiene solo le funzioni per le quali l'utente ha il EXECUTE privilegio o l'utente è il proprietario. Non esiste alcuna garanzia di un ordinamento specifico degli elementi nella matrice.

databricks functions list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

    Nome del catalogo padre per le funzioni di interesse.

SCHEMA_NAME

    Schema padre delle funzioni.

Options

--include-browse

    Indica se includere funzioni nella risposta per cui il principale può accedere solo ai metadati selezionati.

--max-results int

    Numero massimo di funzioni da restituire.

--page-token string

    Token di paginazione non trasparente per passare alla pagina successiva in base alla query precedente.

Flag globali

Examples

L'esempio seguente elenca tutte le funzioni in un catalogo e uno schema:

databricks functions list my_catalog my_schema

L'esempio seguente elenca le funzioni con un massimo di 10 risultati:

databricks functions list my_catalog my_schema --max-results 10

L'esempio seguente elenca le funzioni con le informazioni di esplorazione incluse:

databricks functions list my_catalog my_schema --include-browse

Aggiornamento delle funzioni di databricks

Aggiornare la funzione che corrisponde al nome specificato.

È possibile aggiornare solo il proprietario della funzione. Se l'utente non è un amministratore del metastore, l'utente deve essere membro del gruppo che è il nuovo proprietario della funzione. L'utente deve soddisfare una delle condizioni seguenti:

• Amministratore del metastore
• È il proprietario del catalogo padre della funzione
• È il proprietario dello schema padre della funzione e ha il privilegio sul catalogo padre USE_CATALOG.
• È il proprietario della funzione stessa e ha il privilegio USE_CATALOG sul catalogo padre oltre al privilegio USE_SCHEMA sullo schema padre della funzione

databricks functions update NAME [flags]

Arguments

NAME

    Nome completo della funzione (del formato catalog_name.schema_name.function_name).

Options

--json JSON

    Stringa JSON inline o file JSON @path con il corpo della richiesta.

--owner string

    Nome utente del proprietario corrente della funzione.

Flag globali

Examples

L'esempio seguente aggiorna il proprietario di una funzione:

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

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file stringa

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di formato del log, text o json. Il valore predefinito è text.

--log-level stringa

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di output del comando, text o json. Il valore predefinito è text.

-p, --profile stringa

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target stringa

    Se applicabile, la destinazione del bundle da utilizzare