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

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.

Questa pagina 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. Consultare Che cos'è il Databricks CLI?.

Per installare e configurare l'autenticazione per l'interfaccia della riga di comando di Databricks, vedere Esercitazione sull'interfaccia della riga di comando di Databricks.

Elencare i comandi disponibili dell'interfaccia della riga di comando

Per elencare i gruppi di comandi dell'interfaccia della riga di comando disponibili, usare l'opzione --help o -h , ad esempio:

databricks -h

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

databricks clusters -h

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

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

databricks clusters list -h

Il riferimento ai comandi è anche disponibile. Consultare Comandi della CLI di Databricks.

Eseguire un comando

Informazioni complete sull'utilizzo e sintassi per i singoli comandi sono disponibili nella Guida e nel riferimento della riga di comando, ma i comandi dell'interfaccia della riga di comando di Databricks sono generalmente conformi alla sintassi seguente:

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

Non tutti i comandi hanno sottocomandi aggiuntivi. Sono disponibili flag globali e alcuni comandi hanno flag aggiuntivi. Ad esempio, il comando seguente restituisce i cluster disponibili usando un flag specifico del comando:

databricks clusters list --can-use-client JOBS

Tip

È possibile eseguire i comandi dell'interfaccia della riga di comando di Databricks dall'interno di un'area di lavoro di Databricks usando il terminale Web. Il terminale Web dell'area di lavoro può essere usato da molti utenti in un ambiente di calcolo e non richiede la configurazione dell'autenticazione. Vedere Eseguire i comandi della shell nel terminale Web di Azure Databricks.

Input e output JSON

Alcuni comandi dell'interfaccia della riga di comando di Databricks hanno un flag --json o altre opzioni che accettano un input in formato stringa JSON. Inoltre, alcuni comandi generano una stringa JSON.

Formattazione di stringhe

Il formato delle stringhe JSON dipende dal sistema operativo:

Linux o macOS

Racchiudere i parametri di stringa JSON tra virgolette doppie e racchiudere l'intero payload JSON tra virgolette singole. Per esempio:

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

'["20230323", "Amsterdam"]'

Windows

Racchiudere i parametri della stringa JSON e l'intero payload JSON tra virgolette doppie e precedere i caratteri tra virgolette doppie all'interno del payload JSON con una barra rovesciata (\). Per esempio:

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

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

Impostare i campi in una stringa JSON

Il --json flag in molti comandi consente di impostare campi oggetto che potrebbero non essere disponibili come comandi o opzioni dell'interfaccia della riga di comando. Ad esempio, la chiamata seguente aggiunge un utente con l'ID 9ddddddd-1eee-4eee-a666-8fff7c111111 al gruppo con l'ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux o macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

Filtrare l'output JSON con jq

Per i comandi dell'interfaccia della riga di comando di Databricks che generano JSON, è possibile usare l'elaboratore della riga di comando jq per filtrare l'output. Ad esempio, per elencare solo il nome visualizzato di un cluster Azure Databricks con l'ID cluster specificato:

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

My-11.3-LTS-Cluster

È possibile eseguire l'installazione jq 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.

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.