Grundläggande användning för Databricks CLI

Den här sidan visar hur du listar Databricks CLI-kommandogrupper och -kommandon, visar Hjälp för Databricks CLI och arbetar med Databricks CLI-utdata. Se Databricks CLI.

Information om hur du installerar och konfigurerar autentisering för Databricks CLI finns i Självstudie om Databricks CLI.

Lista tillgängliga CLI-kommandon

Om du vill visa en lista över tillgängliga CLI-kommandogrupper använder du --help alternativet eller -h , till exempel:

databricks -h

Om du vill visa en lista över kommandon för en kommandogrupp använder du --help alternativet eller -h . Om du till exempel vill visa clusters kommandon:

databricks clusters -h

Visa CLI-kommandohjälp

Om du vill visa användningsinformation för ett kommando använder du --help alternativet eller -h med kommandot . Om du till exempel vill visa hjälpen clusters list för kommandot:

databricks clusters list -h

Kommandoreferensen är också tillgänglig. Se Databricks CLI-kommandon.

Köra ett kommando

Fullständig användningsinformation och syntax för enskilda kommandon finns i hjälpen och referensen för kommandoraden, 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

Exempel: Skapa ett Azure Databricks jobb

I följande exempel används CLI för att skapa ett Azure Databricks jobb. Det här jobbet innehåller en arbetsuppgift. Den här uppgiften kör den angivna Azure Databricks notebook-filen. Den här notebook-filen är beroende av en specifik version av PyPI-paketet med namnet wheel. För att köra den här uppgiften skapar jobbet tillfälligt ett jobbkluster som exporterar en miljövariabel med namnet PYSPARK_PYTHON. När jobbet är klart avslutas klustret.

databricks jobs create --json '{
  "name": "My hello notebook job",
  "tasks": [
    {
      "task_key": "my_hello_notebook_task",
      "notebook_task": {
        "notebook_path": "/Workspace/Users/someone@example.com/hello",
        "source": "WORKSPACE"
      },
      "libraries": [
        {
          "pypi": {
            "package": "wheel==0.41.2"
          }
        }
      ],
      "new_cluster": {
        "spark_version": "13.3.x-scala2.12",
        "node_type_id": "Standard_DS3_v2",
        "num_workers": 1,
        "spark_env_vars": {
          "PYSPARK_PYTHON": "/databricks/python3/bin/python3"
        }
      }
    }
  ]
}'

JSON-indata och utdata

Vissa Databricks CLI-kommandon har en --json flagga eller andra alternativ som accepterar JSON-strängindata. Dessutom matar vissa kommandon ut en JSON-sträng.

Strängformatering

Formatet på JSON-strängar beror på operativsystemet:

Linux eller macOS

Omslut JSON-strängparametrar med dubbla citattecken och omslut hela JSON-datan med enkla citattecken. Till exempel:

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

'["20230323", "Amsterdam"]'

Windows

Omslut JSON-strängparametrar och hela JSON-nyttolasten med dubbla citattecken och föregå dubbelcitattecken i JSON-nyttolasten med ett backslash (\). Till exempel:

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

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

Ange fält i en JSON-sträng

Med --json flaggan för många kommandon kan du ange objektfält som kanske inte är tillgängliga som CLI-kommandon eller -alternativ. Följande anrop lägger till exempel till en användare med ID 9ddddddd-1eee-4eee-a666-8fff7c111111 :t i gruppen med ID:t 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux eller 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\"
        }
      ]
    }
  ]
}"

Filtrera JSON-utdata med jq

För Databricks CLI-kommandon som matar ut JSON kan du använda jq-kommandoradsprocessorn 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 på Windows med Chocolatey med choco install jq. Mer information om jqfinns i jq Manual.

Proxyserverkonfiguration

Om du vill dirigera Databricks CLI-begäranden och svar via en proxyserver anger du HTTPS_PROXY miljövariabeln på den dator där Databricks CLI är installerat på proxyserverns URL.

Information om hur du anger miljövariabler finns i dokumentationen till operativsystemet.