Basisgebruik voor de Databricks CLI

  • Artikel

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger, die zich in openbare preview bevinden. Voer de opdracht uit databricks -vom uw versie van de Databricks CLI te vinden.

In dit artikel leest u hoe u Databricks CLI-opdrachtgroepen en -opdrachten weergeeft, help voor Databricks CLI weergeeft en hoe u kunt werken met De CLI-uitvoer van Databricks. Zie Wat is de Databricks CLI?

In dit artikel wordt ervan uitgegaan dat u de Databricks CLI al hebt geïnstalleerd en de CLI hebt ingesteld voor verificatie. Zie:

CLI-opdrachtgroepen weergeven

U geeft de opdrachtgroepen weer met behulp van de --help of -h optie. Voorbeeld:

databricks -h

CLI-opdrachten weergeven

U geeft de opdrachten voor een opdrachtgroep weer met behulp van de --help of -h optie. Als u bijvoorbeeld de clusters opdrachten wilt weergeven:

databricks clusters -h

Help voor CLI-opdrachten weergeven

U geeft de Help voor een opdracht weer met behulp van de --help of -h optie. Als u bijvoorbeeld de Help voor de clusters list opdracht wilt weergeven:

databricks clusters list -h

Gebruiken jq om CLI JSON-uitvoer te parseren

Sommige Databricks CLI-opdrachten bevatten uitvoerantwoorden die zijn opgemaakt als JSON. In veel gevallen formatteert de Databricks CLI de JSON-uitvoer, zodat deze gemakkelijker te lezen is. Soms kan het echter handig zijn om delen van de JSON te parseren in plaats van het hele antwoord weer te geven. Als u bijvoorbeeld alleen de weergavenaam van een Azure Databricks-cluster met de opgegeven cluster-id wilt weergeven, kunt u het hulpprogramma jqgebruiken:

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

Uitvoer:

My-11.3-LTS-Cluster

U kunt bijvoorbeeld installeren jq op macOS door Homebrew met brew install jq of in Windows te gebruiken met Chocolatey met choco install jq. Raadpleeg voor meer informatie over jq de jq-gebruikershandleiding.

JSON-tekenreeksparameters

De indeling van tekenreeksparameters wordt anders verwerkt in JSON, afhankelijk van uw besturingssysteem:

Linux of macos

U moet JSON-tekenreeksparameters tussen dubbele aanhalingstekens plaatsen en u moet de volledige JSON-nettolading tussen enkele aanhalingstekens plaatsen. Een aantal voorbeelden:

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

'["20230323", "Amsterdam"]'

Windows

U moet JSON-tekenreeksparameters en de volledige JSON-nettolading tussen dubbele aanhalingstekens plaatsen en de dubbele aanhalingstekens in de JSON-nettolading moeten worden voorafgegaan door \. Een aantal voorbeelden:

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

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

Proxyserverconfiguratie

Als u Databricks CLI-aanvragen en -antwoorden wilt routeren via een proxyserver, stelt u de HTTPS_PROXY omgevingsvariabele in op de computer waarop de Databricks CLI is geïnstalleerd op de URL van de proxyserver.

Als u omgevingsvariabelen wilt instellen, raadpleegt u de documentatie van uw besturingssysteem.

Globale vlaggen

De volgende vlaggen zijn beschikbaar voor alle Databricks CLI-opdrachten. Houd er rekening mee dat sommige vlaggen niet van toepassing zijn op sommige opdrachten. Zie de documentatie van de opdracht voor meer informatie.

Vlag Beschrijving
-h of --help Help weergeven voor de Databricks CLI of de gerelateerde opdrachtgroep of de gerelateerde opdracht.
-e of --environment string Een tekenreeks die de bundelomgeving vertegenwoordigt die moet worden gebruikt, indien van toepassing voor de gerelateerde opdracht.
--log-file Een tekenreeks die de uitvoerlogboeken naar schrijft. Als deze vlag niet is opgegeven, is het standaardinstelling om uitvoerlogboeken naar stderr te schrijven.
--log-format text om uitvoerlogboeken naar tekst te schrijven of json uitvoerlogboeken naar JSON te schrijven. Als deze vlag niet is opgegeven, worden uitvoerlogboeken geschreven als tekst.
--log-level Een tekenreeks die het niveau van de logboekindeling vertegenwoordigt. Als dit niet is opgegeven, wordt het niveau van de logboekindeling uitgeschakeld.
-o of --output text om uitvoer als tekst te schrijven of json uitvoer als JSON te schrijven. Als deze vlag niet is opgegeven, wordt de uitvoer geschreven als tekst.
-p of --profile Een tekenreeks die het benoemde configuratieprofiel vertegenwoordigt dat in uw .databrickscfg bestand moet worden gebruikt. Als deze vlag niet is opgegeven, wordt het DEFAULT benoemde profiel gebruikt als er een bestaat. U kunt erna --profile drukken Tab of -p een lijst met bestaande beschikbare configuratieprofielen weergeven waaruit u kunt kiezen in plaats van de naam van het configuratieprofiel handmatig in te voeren.
--progress-format De indeling voor voortgangslogboeken die moeten worden weergegeven (defaultde standaardinstelling) of append of inplace ).json