Grundläggande användning för Databricks CLI
Kommentar
Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.
Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.
Den här artikeln visar hur du listar Databricks CLI-kommandogrupper och kommandon, visar Databricks CLI-hjälp och arbetar med Databricks CLI-utdata. Se Vad är Databricks CLI?.
Den här artikeln förutsätter att du redan har installerat Databricks CLI och konfigurerat CLI för autentisering. Se Installera eller uppdatera Databricks CLI- och -autentisering för Databricks CLI-.
Lista CLI-kommandogrupper
Du listar kommandogrupperna med hjälp av alternativet --help eller -h. Till exempel:
databricks -h
Lista CLI-kommandon
Du listar kommandona för alla kommandogrupper med hjälp av alternativet --help eller -h. Om du till exempel vill visa clusters kommandon:
databricks clusters -h
Visa CLI-kommandohjälp
Du visar hjälpen för ett kommando med hjälp --help av alternativet eller -h . Om du till exempel vill visa hjälpen clusters list för kommandot:
databricks clusters list -h
Köra ett kommando
Fullständig användningsinformation och syntax för enskilda kommandon finns i kommandoradshjälpen, men Databricks CLI-kommandon överensstämmer vanligtvis med följande syntax:
databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]
Alla kommandon har inte ytterligare underkommandon. Globala flaggor är tillgängliga och vissa kommandon har ytterligare flaggor. Följande kommando matar till exempel ut tillgängliga kluster med hjälp av en kommandospecifik flagga:
databricks clusters list --can-use-client JOBS
Dricks
Du kan köra Databricks CLI-kommandon från en Databricks-arbetsyta med hjälp av webbterminalen. Webbterminalen kan användas av många användare på en beräkning och kräver inte konfiguration av nycklar. Se Köra gränssnittskommandon i Azure Databricks-webbterminalen.
Använd jq för att filtrera JSON-utdata
Vissa Databricks CLI-kommandon matar ut JSON, vilket innebär att du kan använda jq för att filtrera utdata. Om du till exempel bara vill visa namnet på ett Azure Databricks-kluster med det angivna kluster-ID:t:
databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
My-11.3-LTS-Cluster
Du kan installera jq på macOS med Homebrew med brew install jq eller i Windows med chocolatey med choco install jq. Mer information om jq finns i jq-användarhandboken.
JSON-strängparametrar
Formatet för strängparametrar hanteras på olika sätt i JSON beroende på ditt operativsystem:
Linux eller macOS
Du måste omsluta JSON-strängparametrar med dubbla citattecken och du måste omsluta hela JSON-nyttolasten med enkla citattecken. Några exempel:
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
Windows
Du måste omsluta JSON-strängparametrar och hela JSON-nyttolasten med dubbla citattecken, och dubbelcitattecken i JSON-nyttolasten måste föregås av \. Några exempel:
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"
Proxyserverkonfiguration
Om du vill dirigera Databricks CLI-begäranden och svar via en proxyserver anger du miljövariabeln HTTPS_PROXY på datorn där Databricks CLI är installerat på proxyserverns URL.
Information om hur du anger miljövariabler finns i dokumentationen till operativsystemet.