Grundlegende Nutzung der Databricks-CLI

  • Artikel

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. Thema

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

Verwenden Sie jq, um die CLI-JSON-Ausgabe zu parsen

Einige Ausgabeantworten der Databricks CLI-Befehle sind als JSON formatiert. In vielen Fällen formatiert die Databricks CLI die JSON-Ausgabe so, dass sie einfacher zu lesen ist. Manchmal kann es jedoch hilfreich sein, Teile des JSON-Codes zu analysieren, anstatt die gesamte Antwort aufzulisten. Wenn Sie beispielsweise nur den Anzeigenamen eines Azure Databricks-Clusters mit der angegebenen Cluster-ID auflisten möchten, können Sie das Hilfsprogramm jq verwenden:

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

Ausgabe:

My-11.3-LTS-Cluster

Sie können jq beispielsweise unter macOS mithilfe von Homebrew mit brew install jq oder unter Windows mithilfe von Chocolatey mit 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.

Globale Flags

Die folgenden Flags sind für alle Databricks CLI-Befehle verfügbar. Beachten Sie, dass einige Flags für einige Befehle nicht gelten. Weitere Informationen finden Sie in der Dokumentation des Befehls.

Flag Beschreibung
-h oder --help Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.
-e oder --environment string Eine Zeichenfolge, die die Bündelumgebung darstellt, die ggf. für den zugehörigen Befehl verwendet werden soll.
--log-file Eine Zeichenfolge, die die Ausgabeprotokolle darstellt, in die geschrieben werden soll. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.
--log-format text, um Ausgabeprotokolle in Text zu schreiben, oder json, um Ausgabeprotokolle in JSON zu schreiben. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle als Text geschrieben.
--log-level Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.
-o oder --output text, um die Ausgabe als Text zu schreiben, oder json, um die Ausgabe als JSON zu schreiben. Wenn dieses Flag nicht angegeben ist, wird die Ausgabe als Text geschrieben.
-p oder --profile Eine Zeichenfolge, die das benannte Konfigurationsprofil darstellt, das in Ihrer .databrickscfg-Datei verwendet werden soll. Wenn dieses Flag nicht angegeben ist, wird das benannte DEFAULT-Profil verwendet, sofern vorhanden. Sie können Tab nach --profile oder -p drücken, um eine Liste der vorhandenen verfügbaren Konfigurationsprofile anzuzeigen, aus der Sie auswählen können, anstatt den Namen des Konfigurationsprofils manuell einzugeben.
--progress-format Das Format für die Anzeige von Statusprotokollen (default (Standard) oder append oder inplace oder json).