Basisgebruik voor de Databricks CLI

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger. De Databricks CLI bevindt zich in openbare preview.

Databricks CLI-gebruik is onderhevig aan de Databricks-licentie en de privacyverklaring van Databricks, met inbegrip van alle bepalingen voor gebruiksgegevens.

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 De Databricks CLI en verificatie voor de Databricks CLI installeren of bijwerken.

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

Een opdracht uitvoeren

Volledige gebruiksinformatie en syntaxis voor afzonderlijke opdrachten vindt u in de opdrachtregelhulp, maar Databricks CLI-opdrachten voldoen over het algemeen aan de volgende syntaxis:

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

Niet elke opdracht heeft extra subopdrachten. Globale vlaggen zijn beschikbaar en sommige opdrachten hebben extra vlaggen. Met de volgende opdracht worden bijvoorbeeld beschikbare clusters uitgevoerd met behulp van een opdrachtspecifieke vlag:

databricks clusters list --can-use-client JOBS

Tip

U kunt Databricks CLI-opdrachten uitvoeren vanuit een Databricks-werkruimte met behulp van de webterminal. Webterminal kan door veel gebruikers op één rekenproces worden gebruikt en hoeft geen sleutels in te stellen. Zie Shell-opdrachten uitvoeren in de Azure Databricks-webterminal.

Gebruiken jq om JSON-uitvoer te filteren

Sommige Databricks CLI-opdrachten voeren JSON uit. Dit betekent dat u jq kunt gebruiken om de uitvoer te filteren. Als u bijvoorbeeld alleen de weergavenaam van een Azure Databricks-cluster met de opgegeven cluster-id wilt weergeven:

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

My-11.3-LTS-Cluster

U kunt installeren jq op macOS met homebrew met brew install jq of in Windows 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.