Sdílet prostřednictvím


Základní použití rozhraní příkazového řádku Databricks

Note

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší. Rozhraní příkazového řádku Databricks je ve veřejné ukázce.

Použití rozhraní příkazového řádku Databricks podléhá licenci Databricks a oznámení o ochraně osobních údajů Databricks, včetně všech ustanovení o využití.

Na této stránce se dozvíte, jak vypsat skupiny příkazů a příkazy rozhraní příkazového řádku Databricks, zobrazit nápovědu k rozhraní příkazového řádku Databricks a pracovat s výstupem rozhraní příkazového řádku Databricks. Podívejte se, co je rozhraní příkazového řádku Databricks?

Informace o instalaci a konfiguraci ověřování pro rozhraní příkazového řádku Databricks najdete v kurzu k Rozhraní příkazového řádku Databricks.

Výpis dostupných příkazů rozhraní příkazového řádku

Pokud chcete zobrazit seznam dostupných skupin příkazů rozhraní příkazového řádku, použijte možnost --help nebo -h, například:

databricks -h

Pokud chcete zobrazit seznam příkazů pro libovolnou skupinu příkazů, použijte --help možnost nebo -h příkaz. Pokud chcete například zobrazit seznam clusters příkazů:

databricks clusters -h

Zobrazení nápovědy k příkazu rozhraní příkazového řádku

Pokud chcete zobrazit informace o využití pro příkaz, použijte možnost --help nebo -h s daným příkazem. Pokud chcete například zobrazit nápovědu clusters list pro příkaz:

databricks clusters list -h

K dispozici je také odkaz na příkaz. Podívejte se na příkazy rozhraní příkazového řádku Databricks.

Spuštění příkazu

Kompletní informace o použití a syntaxi jednotlivých příkazů najdete v nápovědě a referenci příkazového řádku, ale příkazy rozhraní příkazového řádku Databricks obecně odpovídají následující syntaxi:

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

Ne každý příkaz má další podpříkazy. K dispozici jsou globální příznaky a některé příkazy mají další příznaky. Například následující příkaz vypíše dostupné clustery pomocí příznaku specifického pro příkaz:

databricks clusters list --can-use-client JOBS

Tip

Příkazy rozhraní příkazového řádku Databricks můžete spouštět z pracovního prostoru Databricks pomocí webového terminálu. Webový terminál pracovního prostoru může používat mnoho uživatelů na jednom výpočetním prostředí a nevyžaduje konfiguraci ověřování. Viz příkazy run shellu ve webovém terminálu Azure Databricks.

Vstup a výstup JSON

Některé příkazy rozhraní příkazového řádku Databricks mají --json příznak nebo jiné možnosti, které přijímají vstup řetězce JSON. Některé příkazy navíc vypíše řetězec JSON.

Formátování řetězců

Formát řetězců JSON závisí na vašem operačním systému:

Linux nebo macOS

Uzavřete parametry řetězce JSON do dvojitých uvozovek a uzavřete celou datovou část JSON do jednoduchých uvozovek. Například:

'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'

Windows

Uzavřete parametry řetězce JSON a celou datovou část JSON do dvojitých uvozovek a před znaky dvojitých uvozovek uvnitř datové části JSON zadejte zpětné lomítko (\). Například:

"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"

Nastavení polí v řetězci JSON

Příznak --json pro mnoho příkazů umožňuje nastavit pole objektů, která nemusí být k dispozici jako příkazy nebo možnosti rozhraní příkazového řádku. Například následující volání přidá uživatele s ID 9ddddddd-1eee-4eee-a666-8fff7c111111 do skupiny s ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

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

Filtrování výstupu JSON pomocí jq

Pro příkazy CLI Databricks, které vypisují JSON, můžete k filtrování výstupu použít nástroj příkazového řádku jq. Pokud například chcete zobrazit jenom zobrazovaný název clusteru Azure Databricks se zadaným ID clusteru:

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
My-11.3-LTS-Cluster

Na macOS můžete nainstalovat jq homebrew s brew install jq windows nebo ve Windows pomocí Chocolatey s choco install jq. Další informace o nástroji jq najdete v příručce k nástroji jq.

Konfigurace proxy serveru

Pokud chcete směrovat požadavky a odpovědi rozhraní příkazového řádku Databricks prostřednictvím proxy serveru, nastavte HTTPS_PROXY proměnnou prostředí na počítači, kde je rozhraní příkazového řádku Databricks nainstalované na adresu URL proxy serveru.

Pokud chcete nastavit proměnné prostředí, přečtěte si dokumentaci k vašemu operačnímu systému.