Podstawowe użycie interfejsu wiersza polecenia usługi Databricks

Note

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Na tej stronie pokazano, jak wyświetlić listę grup poleceń i poleceń interfejsu wiersza polecenia usługi Databricks, wyświetlić pomoc interfejsu wiersza polecenia usługi Databricks i pracować z danymi wyjściowymi interfejsu wiersza polecenia usługi Databricks. Zobacz Co to jest interfejs wiersza polecenia usługi Databricks?.

Aby zainstalować i skonfigurować uwierzytelnianie dla interfejsu wiersza polecenia usługi Databricks, zobacz Samouczek interfejsu wiersza polecenia usługi Databricks.

Lista dostępnych poleceń CLI

Aby wyświetlić listę dostępnych grup poleceń wiersza polecenia, użyj opcji --help lub -h, na przykład:

databricks -h

Aby wyświetlić listę poleceń dla dowolnej grupy poleceń, użyj --help opcji lub -h . Aby na przykład wyświetlić listę poleceń clusters:

databricks clusters -h

Wyświetlanie pomocy dotyczącej poleceń interfejsu wiersza polecenia

Aby wyświetlić informacje o użyciu polecenia, użyj opcji --help albo -h wraz z poleceniem. Aby na przykład wyświetlić pomoc dla clusters list polecenia:

databricks clusters list -h

Dostępne jest również odwołanie do poleceń. Zobacz Polecenia CLI Databricks.

Uruchamianie polecenia

Pełne informacje o użyciu i składnia poszczególnych poleceń można znaleźć w pomocy wiersza polecenia i dokumentacji, ale polecenia interfejsu wiersza polecenia usługi Databricks są ogólnie zgodne z następującą składnią:

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

Nie każde polecenie ma dodatkowe polecenia podrzędne. Dostępne są flagi globalne, a niektóre polecenia mają dodatkowe flagi. Na przykład następujące polecenie zwraca dostępne klastry przy użyciu flagi specyficznej dla polecenia:

databricks clusters list --can-use-client JOBS

Tip

Polecenia interfejsu wiersza polecenia usługi Databricks można uruchamiać z poziomu obszaru roboczego usługi Databricks przy użyciu terminalu internetowego. Terminal internetowy obszaru roboczego może być używany przez wielu użytkowników w jednym środowisku obliczeniowym i nie wymaga skonfigurowania uwierzytelniania. Zobacz Uruchamianie poleceń powłoki w terminalu internetowym usługi Azure Databricks.

Dane wejściowe i wyjściowe JSON

Niektóre polecenia CLI Databricks mają flagę --json lub inne opcje, które akceptują dane wejściowe ciągu JSON. Ponadto niektóre polecenia wyświetlają ciąg JSON.

Formatowanie ciągu

Format ciągów JSON zależy od systemu operacyjnego:

Linux lub macOS

Ujmij parametry ciągu JSON w cudzysłowach podwójnych i ująć cały ładunek JSON w cudzysłów pojedynczych. Przykład:

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

'["20230323", "Amsterdam"]'

Windows

Ujmij parametry ciągu JSON i cały ładunek JSON w podwójnych cudzysłowach, a znaki podwójnego cudzysłowu wewnątrz ładunku JSON poprzedź znakiem ukośnika odwrotnego (\). Przykład:

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

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

Ustawianie pól w ciągu JSON

Flaga --json na wielu poleceniach umożliwia ustawienie pól obiektów, które mogą nie być dostępne jako polecenia interfejsu wiersza polecenia lub opcje. Na przykład następujące wywołanie dodaje użytkownika o identyfikatorze 9ddddddd-1eee-4eee-a666-8fff7c111111 do grupy o identyfikatorze 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

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

Filtrowanie danych wyjściowych JSON za pomocą polecenia jq

W przypadku poleceń interfejsu wiersza polecenia usługi Databricks, które wyświetlają dane wyjściowe w formacie JSON, można użyć procesora wiersza polecenia jq do filtrowania danych wyjściowych. Aby na przykład wyświetlić tylko nazwę wyświetlaną klastra usługi Azure Databricks o określonym identyfikatorze klastra:

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

My-11.3-LTS-Cluster

Instalację w systemie macOS można zainstalować jq przy użyciu oprogramowania Homebrew z brew install jq systemem Windows lub w systemie Windows przy użyciu narzędzia Chocolatey z choco install jqprogramem . Aby uzyskać więcej informacji na temat jq, zapoznaj się z podręcznikiem jq.

Konfiguracja serwera proxy

Aby kierować żądania interfejsu wiersza polecenia usługi Databricks i odpowiedzi za pośrednictwem serwera proxy, ustaw HTTPS_PROXY zmienną środowiskową na maszynie, na której jest zainstalowany interfejs wiersza polecenia usługi Databricks, na adres URL serwera proxy.

Aby ustawić zmienne środowiskowe, zapoznaj się z dokumentacją systemu operacyjnego.