Basisgebruik voor de Databricks CLI

Note

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.

Op deze pagina ziet u hoe u Databricks CLI-opdrachtgroepen en -opdrachten weergeeft, help van Databricks CLI weergeeft en hoe u kunt werken met Databricks CLI-uitvoer. Zie Wat is de Databricks CLI?

Als u verificatie voor de Databricks CLI wilt installeren en configureren, raadpleegt u de zelfstudie over Databricks CLI.

Beschikbare CLI-opdrachten weergeven

Als u beschikbare CLI-opdrachtgroepen wilt weergeven, gebruikt u de --help of -h optie, bijvoorbeeld:

databricks -h

Als u de opdrachten voor een opdrachtgroep wilt weergeven, gebruikt u de --help of -h optie. Als u bijvoorbeeld de clusters opdrachten wilt weergeven:

databricks clusters -h

Help voor CLI-opdrachten weergeven

Als u gebruiksgegevens voor een opdracht wilt weergeven, gebruikt u de --help of -h optie met de opdracht. Als u bijvoorbeeld de Help voor de clusters list opdracht wilt weergeven:

databricks clusters list -h

Er is ook een opdrachtreferentie beschikbaar. Zie Databricks CLI-opdrachten.

Een opdracht uitvoeren

Volledige gebruiksinformatie en syntaxis voor afzonderlijke opdrachten vindt u in de opdrachtregelhulp en -verwijzing, 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. De werkruimtewebterminal kan door veel gebruikers op één rekenproces worden gebruikt en u hoeft geen verificatie te configureren. Zie Shell-opdrachten uitvoeren in de Azure Databricks-webterminal.

JSON-invoer en -uitvoer

Sommige Databricks CLI-opdrachten hebben een --json vlag of andere opties die JSON-tekenreeksinvoer accepteren. Daarnaast voeren sommige opdrachten een JSON-tekenreeks uit.

Tekenreeksopmaak

De indeling van JSON-tekenreeksen is afhankelijk van uw besturingssysteem:

Linux of macOS

Plaats de JSON-tekenreeksparameters tussen dubbele aanhalingstekens en plaats de volledige JSON-nettolading tussen enkele aanhalingstekens. Voorbeeld:

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

'["20230323", "Amsterdam"]'

Windows

Plaats de JSON-tekenreeksparameters en de volledige JSON-inhoud tussen dubbele aanhalingstekens en voorzie de dubbele aanhalingstekens binnen de JSON-inhoud van een backslash (\). Voorbeeld:

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

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

Velden instellen in een JSON-tekenreeks

Met de --json vlag voor veel opdrachten kunt u objectvelden instellen die mogelijk niet beschikbaar zijn als CLI-opdrachten of -opties. Met de volgende aanroep wordt bijvoorbeeld een gebruiker met de id 9ddddddd-1eee-4eee-a666-8fff7c111111 aan de groep toegevoegd met de id 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux of macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

JSON-uitvoer filteren met jq

Voor Databricks CLI-opdrachten die JSON uitvoeren, kunt u de jq-opdrachtregelprocessor 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.

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.