Utilizzo di base per l'interfaccia della riga di comando di Databricks

Nota

Queste informazioni si applicano alle versioni dell'interfaccia della riga di comando di Databricks 0.205 e successive, disponibili in anteprima pubblica. Per trovare la versione dell'interfaccia della riga di comando di Databricks, eseguire databricks -v.

Questo articolo illustra come elencare i gruppi e i comandi dell'interfaccia della riga di comando di Databricks, visualizzare la Guida dell'interfaccia della riga di comando di Databricks e usare l'output dell'interfaccia della riga di comando di Databricks. Vedere Che cos'è l'interfaccia della riga di comando di Databricks?.

Questo articolo presuppone che sia già stata installata l'interfaccia della riga di comando di Databricks e che sia stata configurata l'interfaccia della riga di comando per l'autenticazione. Vedere:

• Installare o aggiornare l'interfaccia della riga di comando di Databricks
• Autenticazione per l'interfaccia della riga di comando di Databricks

Elencare i gruppi di comandi dell'interfaccia della riga di comando

È possibile elencare i gruppi di comandi usando l'opzione --help o -h . Ad esempio:

databricks -h

Elencare i comandi dell'interfaccia della riga di comando

È possibile elencare i comandi per qualsiasi gruppo di comandi usando l'opzione --help o -h . Ad esempio, per elencare i clusters comandi:

databricks clusters -h

Visualizzare la Guida dei comandi dell'interfaccia della riga di comando

Per visualizzare la Guida per un comando, usare l'opzione --help o -h . Ad esempio, per visualizzare la Guida per il clusters list comando:

databricks clusters list -h

Usare jq per analizzare l'output JSON dell'interfaccia della riga di comando

Alcuni comandi dell'interfaccia della riga di comando di Databricks reputano risposte formattate come JSON. In molti casi, l'interfaccia della riga di comando di Databricks formatta l'output JSON in modo che sia più facile da leggere. Tuttavia, a volte può essere utile analizzare parti del codice JSON anziché elencare l'intera risposta. Ad esempio, per elencare solo il nome visualizzato di un cluster Di Azure Databricks con l'ID cluster specificato, è possibile usare l'utilità jq:

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

Output:

My-11.3-LTS-Cluster

È possibile installare jq ad esempio in macOS usando Homebrew con brew install jq o in Windows usando Chocolatey con choco install jq. Per altre informazioni su jq, vedere il manuale di jq.

Parametri della stringa JSON

Il formato dei parametri stringa viene gestito in modo diverso in JSON a seconda del sistema operativo:

Linux o macos

È necessario racchiudere i parametri di stringa JSON tra virgolette doppie ed è necessario racchiudere l'intero payload JSON tra virgolette singole. Alcuni esempi:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

È necessario racchiudere i parametri della stringa JSON e l'intero payload JSON tra virgolette doppie e i caratteri tra virgolette doppie all'interno del payload JSON devono essere preceduti da \. Alcuni esempi:

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Configurazione del server proxy

Per instradare le richieste e le risposte dell'interfaccia della riga di comando di Databricks tramite un server proxy, impostare la HTTPS_PROXY variabile di ambiente nel computer in cui è installata l'interfaccia della riga di comando di Databricks nell'URL del server proxy.

Per impostare le variabili di ambiente, vedere la documentazione del sistema operativo.

Flag globali

I flag seguenti sono disponibili per tutti i comandi dell'interfaccia della riga di comando di Databricks. Si noti che alcuni flag non si applicano ad alcuni comandi. Per altre informazioni, vedere la documentazione del comando.

Flag	Descrizione
-h oppure --help	Visualizzare la Guida per l'interfaccia della riga di comando di Databricks o il gruppo di comandi correlato o il comando correlato.
-e oppure --environment string	Stringa che rappresenta l'ambiente bundle da usare se applicabile per il comando correlato.
--log-file	Stringa che rappresenta l'oggetto in cui scrivere i log di output. Se questo flag non viene specificato, il valore predefinito consiste nel scrivere i log di output in stderr.
--log-format	text per scrivere i log di output in testo o json per scrivere i log di output in JSON. Se questo flag non viene specificato, i log di output vengono scritti come testo.
--log-level	Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.
-o oppure --output	text per scrivere l'output come testo o json scrivere l'output come JSON. Se questo flag non viene specificato, l'output viene scritto come testo.
-p oppure --profile	Stringa che rappresenta il profilo di configurazione denominato da usare all'interno del .databrickscfg file. Se questo flag non viene specificato, il DEFAULT profilo denominato viene usato se ne esiste uno. È possibile premere Tab dopo --profile o -p per visualizzare un elenco di profili di configurazione disponibili esistenti tra cui scegliere anziché immettere manualmente il nome del profilo di configurazione.
--progress-format	Formato per i log di stato da visualizzare (default (impostazione predefinita) o append o inplacejson.