Grundlegende Nutzung der Databricks-CLI

Hinweis

Diese Informationen gelten für die Databricks-CLI-Version 0.205 und höher, die als Public Preview verfügbar sind. Führen Sie databricks -v aus, um die Version Ihrer Databricks CLI zu ermitteln.

In diesem Abschnitt erfahren Sie, wie Sie Databricks-CLI-Befehlsgruppen und -Befehle auflisten, Databricks-CLI-Hilfe anzeigen und mit der Databricks CLI-Ausgabe arbeiten. Weitere Informationen finden Sie unter Was ist die Databricks-CLI?.

In diesem Artikel wird davon ausgegangen, dass Sie die Databricks-CLI bereits installiert und für die Authentifizierung eingerichtet haben. Siehe Installieren oder Aktualisieren der Databricks CLI und Authentifizierung für Databricks CLI.

Auflisten von CLI-Befehlsgruppen

Die Befehlsgruppe werden mithilfe der Option --help oder -h aufgelistet. Beispiel:

databricks -h

Auflisten der CLI-Befehle

Die Befehle für eine Befehlsgruppe werden mithilfe der Option --help oder -h aufgelistet. So listen Sie beispielsweise die clusters-Befehle auf:

databricks clusters -h

Anzeigen der Hilfe zum CLI-Befehl

Die Hilfe für einen Unterbefehl wird mithilfe der Option --help oder -h angezeigt. So zeigen Sie beispielsweise die Hilfe für den Befehl clusters list an:

databricks clusters list -h

Ausführen eines Befehls

Vollständige Verwendungsinformationen und Syntax für einzelne Befehle finden Sie in der Befehlszeilenhilfe, aber Databricks CLI-Befehle im Allgemeinen der folgenden Syntax entsprechen:

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

Nicht jeder Befehl verfügt über zusätzliche Unterbefehle. Globale Flags sind verfügbar und einige Befehle verfügen über zusätzliche Flags. Beispielsweise gibt der folgende Befehl verfügbare Cluster mithilfe eines befehlsspezifischen Flags aus:

databricks clusters list --can-use-client JOBS

Tipp

Sie können Databricks CLI-Befehle in einem Databricks-Arbeitsbereich mithilfe des Webterminals ausführen. Webterminal kann von vielen Benutzerinnen und Benutzern auf einem Compute verwendet werden und erfordert keine Einrichtung von Schlüsseln. Siehe Ausführen von Shellbefehlen im Azure Databricks-Webterminal.

Verwenden Sie jq zum Filtern der JSON-Ausgabe

Einige Databricks CLI-Befehle geben JSON aus, was bedeutet, dass Sie jq verwenden können, um die Ausgabe zu filtern. Wenn Sie beispielsweise nur den Anzeigenamen eines Azure Databricks-Clusters mit der angegebenen Cluster-ID auflisten möchten:

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

My-11.3-LTS-Cluster

Sie können jq unter macOS mithilfe von Homebrew (brew install jq) oder unter Windows mithilfe von Chocolatey (choco install jq) installieren. Weitere Informationen zu jq finden Sie im Leitfaden zu jq.

JSON-Zeichenfolgenparameter

Das Format von Zeichenfolgenparametern wird in JSON je nach Betriebssystem unterschiedlich behandelt:

Linux oder macOS

Sie müssen JSON-Zeichenfolgenparameter in doppelte Anführungszeichen einschließen, und Sie müssen die gesamte JSON-Nutzlast in einfache Anführungszeichen einschließen. Einige Beispiele:

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

'["20230323", "Amsterdam"]'

Windows

Sie müssen JSON-String-Parameter und die gesamte JSON-Nutzlast in doppelte Anführungszeichen einschließen, und den doppelten Anführungszeichen innerhalb der JSON-Nutzlast muss ein \ vorangestellt sein. Einige Beispiele:

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

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

Proxyserverkonfiguration

Um Databricks CLI-Anforderungen und -Antworten über einen Proxyserver weiterzuleiten, legen Sie die HTTPS_PROXY Umgebungsvariable auf dem Computer fest, auf dem die Databricks CLI auf der URL des Proxyservers installiert ist.

Informationen zum Festlegen von Umgebungsvariablen finden Sie in der Dokumentation des Betriebssystems.