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

  • Článek

Poznámka:

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší, které jsou ve verzi Public Preview. Pokud chcete zjistit svou verzi rozhraní příkazového řádku Databricks, spusťte databricks -vpříkaz .

V tomto článku 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?

Tento článek předpokládá, že jste už nainstalovali Rozhraní příkazového řádku Databricks a nastavili rozhraní příkazového řádku pro ověřování. Přečtěte si:

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

Skupiny příkazů zobrazíte pomocí --help nebo -h možnosti. Příklad:

databricks -h

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

Příkazy pro libovolnou skupinu příkazů zobrazíte pomocí --help možnosti nebo -h příkazu. Pokud chcete například zobrazit seznam clusters příkazů:

databricks clusters -h

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

Nápovědu k příkazu zobrazíte pomocí --help možnosti nebo -h příkazu. Pokud chcete například zobrazit nápovědu clusters list pro příkaz:

databricks clusters list -h

Použití jq k analýze výstupu JSON rozhraní příkazového řádku

Některé výstupní odpovědi příkazů rozhraní příkazového řádku Databricks jsou formátované jako JSON. V mnoha případech rozhraní příkazového řádku Databricks formátuje výstup JSON, aby se snadněji četl. Někdy ale může být užitečné analyzovat části JSON místo výpisu celé odpovědi. Pokud například chcete zobrazit jenom zobrazovaný název clusteru Azure Databricks se zadaným ID clusteru, můžete použít nástroj jq:

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

Výstup:

My-11.3-LTS-Cluster

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

Parametry řetězců JSON

Formát parametrů řetězce se zpracovává jinak ve formátu JSON v závislosti na vašem operačním systému:

Linux nebo macos

Parametry řetězce JSON musíte uzavřít do dvojitých uvozovek a musíte uzavřít celou datovou část JSON do jednoduchých uvozovek. Některé příklady:

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

'["20230323", "Amsterdam"]'

Windows

Parametry řetězce JSON a celou datovou část JSON musíte uzavřít do dvojitých uvozovek a před znaky s dvojitou uvozovkou uvnitř datové části \JSON. Některé příklady:

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

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

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.

Globální příznaky

Následující příznaky jsou k dispozici pro všechny příkazy Rozhraní příkazového řádku Databricks. Všimněte si, že některé příznaky se na některé příkazy nevztahují. Další informace najdete v dokumentaci k příkazu.

Příznak Popis
-h nebo --help Zobrazení nápovědy k rozhraní příkazového řádku Databricks nebo související skupině příkazů nebo souvisejícímu příkazu
-e nebo --environment string Řetězec představující prostředí sady prostředků, které se má použít, pokud je to možné pro související příkaz.
--log-file Řetězec představující zápis výstupních protokolů do. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.
--log-format text k zápisu výstupních protokolů do textu nebo json k zápisu výstupních protokolů do FORMÁTU JSON. Pokud tento příznak není zadaný, výstupní protokoly se zapíšou jako text.
--log-level Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.
-o nebo --output text k zápisu výstupu jako textu nebo json k zápisu výstupu ve formátu JSON. Pokud tento příznak není zadán, výstup se zapíše jako text.
-p nebo --profile Řetězec představující pojmenovaný konfigurační profil, který se má použít v rámci souboru .databrickscfg . Pokud tento příznak není zadán, DEFAULT použije se pojmenovaný profil, pokud existuje. Můžete stisknout Tab po --profile nebo -p zobrazit seznam existujících dostupných konfiguračních profilů, ze které si můžete vybrat místo ručního zadávání názvu konfiguračního profilu.
--progress-format Formát pro zobrazení protokolů průběhu (default (výchozí) nebo appendinplace nebo json).