Sdílet prostřednictvím

Příkazy příkazového řádku Databricks

  • Článek

Poznámka:

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

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í.

Tento článek obsahuje informace o dostupných příkazech rozhraní příkazového řádku Databricks. Tyto informace doplňují nápovědu k příkazovému řádku. Další informace o instalaci a používání rozhraní příkazového řádku Databricks najdete v tématu Instalace nebo aktualizace rozhraní příkazového řádku Databricks a Co je rozhraní příkazového řádku Databricks?.

Rozhraní příkazového řádku Databricks obsahuje skupiny příkazů uvedené v následujících tabulkách. Skupiny příkazů obsahují sady souvisejících příkazů, které mohou také obsahovat dílčí příkazy. Výstup informací o použití a syntaxi pro skupinu příkazů, jednotlivé příkazy nebo dílčí příkazy:

  • databricks <command-group> -h
  • databricks <command-group> <command-name> -h
  • databricks <command-group> <command-name> <subcommand-name> -h

Mnoho příkazů rozhraní příkazového řádku odpovídá operacím, které jsou popsány v referenční dokumentaci Azure Databricks REST API.

Příkazy pracovního prostoru

Skupina Popis a příkazy
Fs Příkazy pro správu souborů a systému souborů:
cat, cp, ls, , mkdirrm
git-credentials Příkazy pro registraci osobních přístupových tokenů pro Databricks za účelem provádění operací jménem uživatele:
create, delete, get, , listupdate
repos Příkazy pro povolení správy úložišť Git uživatelům:
create, delete, get, , listupdate
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
secrets Příkazy pro správu tajných kódů, oborů tajných kódů a přístupových oprávnění:
create-scope, delete-acl, delete-scope, delete-secret, get-acl, get-secret, list-acls, list-scopes, list-secrets, put-acl, put-secret
workspace Příkazy pro výpis, import, export a odstranění poznámkových bloků a složek v pracovním prostoru:
delete, export, export-dir, , get-statusimport, import-dir, , listmkdirs
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Výpočetní příkazy

Skupina Popis a příkazy
cluster-policies Příkazy pro řízení schopnosti uživatelů konfigurovat clustery na základě sady pravidel:
create, delete, edit, , getlist
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
clusters Příkazy, které umožňují vytvářet, spouštět, upravovat, vypisovat, ukončovat a odstraňovat clustery:
change-owner, create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete, pin, resize, restart, spark-versions, start, unpin
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
global-init-scripts Příkazy, které správcům pracovního prostoru umožňují konfigurovat skripty globální inicializace pro svůj pracovní prostor:
create, delete, get, , listupdate
instance-pools Příkazy pro vytváření, úpravu, odstraňování a výpis fondů instancí pomocí cloudových instancí připravených k použití, které snižují dobu spuštění a automatického škálování clusteru:
create, delete, edit, , getlist
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
instance-profiles Příkazy umožňující správcům přidávat, vypisovat a odebírat profily instancí, se kterými můžou uživatelé spouštět clustery:
add, edit, , listremove
libraries Příkazy pro instalaci, odinstalaci a získání stavu knihoven v clusteru:
all-cluster-statuses, cluster-status, , installuninstall
policy-families Příkazy pro zobrazení dostupných kategorií zásad:
get, list

Příkazy úloh

Skupina Popis a příkazy
jobs Příkazy pro správu úloh:
cancel-all-runs, cancel-run, create, delete, delete-run, export-run, get, get-run, get-run-output, list, list-runs, repair-run, reset, run-now, submit, update
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy DLT

Skupina Popis a příkazy
pipelines Příkazy pro vytvoření, úpravu, odstranění, spuštění a zobrazení podrobností o kanálech:
create, delete, get, get-update, list-pipeline-events, list-pipelines, list-updates, start-update, stop, update
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy služby Machine Learning

Skupina Popis a příkazy
experiments Příkazy pro interakci s experimenty, které jsou primární jednotkou organizace v MLflow; všechna spuštění MLflow patří do experimentu:
create-experiment, create-run, delete-experiment, delete-run, delete-runsdelete-tagget-by-nameget-experimentget-historyget-runGetlist-artifactslist-experimentslog-batchlog-inputslog-metriclog-modellog-paramrestore-experimentrestore-runrestore-runssearch-experimentssearch-runsset-experiment-tagset-tagupdate-experimentupdate-run
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
model-registry Příkazy pro registr modelů pracovního prostoru:
approve-transition-request, create-comment, create-model, create-model-version, create-transition-request, create-webhook, delete-comment, delete-model, delete-model-tag, delete-model-version, delete-model-version-tag, delete-transition-request, delete-webhook, get-latest-versions, get-model, get-model-version, get-model-version-download-uri, list-models, list-transition-requests, list-webhooks, reject-transition-request, rename-model, search-model-versions, search-models, set-model-tag, set-model-version-tag, test-registry-webhook, transition-stage, update-comment, update-model, update-model-version, update-webhook
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy obsluhy v reálném čase

Skupina Popis a příkazy
serving-endpoints Příkazy pro vytváření, aktualizaci a odstraňování koncových bodů obsluhy modelu:
build-logs, create, delete, export-metrics, get, list, logs, patch, put, query, update-config
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy pro správu identit a přístupu

Skupina Popis a příkazy
account Příkazy pro správu účtů Databricks:
  • Identita a přístup: access-control, groups, service-principals, users, workspace-assignment
  • Katalog Unity: metastore-assignments, metastores, storage-credentials
  • Nastavení: ip-access-lists, network-connectivity, settings
  • Zřizování: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces
  • Fakturace: billable-usage, log-delivery
  • OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
Auth Příkazy pro ověřování:
describe, env, login, , profilestoken
current-user Příkazy pro načtení informací o aktuálně ověřeném uživateli nebo aplikačním objektu:
me
groups Příkazy pro skupiny, které zjednodušují správu identit, usnadňují přiřazování přístupu k pracovnímu prostoru Databricks, datům a dalším zabezpečitelným objektům:
create, delete, get, list, , patchupdate
permissions Příkazy pro vytváření čtení, zápisu, úpravy, aktualizace a správy přístupu pro různé uživatele v různých objektech a koncových bodech:
get, set, update
get-permission-levels
service-principals Příkazy pro identity pro použití s úlohami, automatizovanými nástroji a systémy, jako jsou skripty, aplikace a platformy CI/CD:
create, delete, get, list, , patchupdate
users Příkazy pro identity uživatelů rozpoznané službou Databricks a reprezentované e-mailovými adresami:
create, delete, get, list, , patchupdate
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
Skupina Popis a příkazy
alerts Příkazy pro provádění operací s upozorněními:
create, delete, get, , listupdate
data-sources Příkazy pro vytváření nových objektů dotazů:
list
queries Příkazy pro provádění operací s definicemi dotazů:
create, delete, get, list, , restoreupdate
query-history Příkazy pro přístup k historii dotazů prostřednictvím SQL Warehouse:
list
warehouses Příkazy pro správu skladů SQL, což je výpočetní prostředek, který umožňuje spouštět příkazy SQL na datových objektech v rámci Databricks SQL:
create, delete, edit, get, get-workspace-warehouse-config, list, set-workspace-warehouse-config, start, stop
get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy katalogu Unity

Skupina Popis a příkazy
artifact-allowlists Příkazy pro správu seznamů povolených artefaktů Ve službě Databricks Runtime 13.3 a novějších můžete do seznamu povolených v UC přidat knihovny a inicializační skripty, aby uživatelé mohli využívat tyto artefakty na výpočetních prostředcích nakonfigurovaných pomocí standardního režimu přístupu:
get, update
catalogs Příkazy ke správě katalogů, první vrstvy tříúrovňového oboru názvů Unity Catalog:
create, delete, get, , listupdate
connections Příkazy pro vytvoření připojení k externímu zdroji dat:
create, delete, get, , listupdate
external-locations Příkazy pro správu externích umístění, které kombinují cestu cloudového úložiště s přihlašovacími údaji úložiště, které autorizuje přístup k cestě cloudového úložiště:
create, delete, get, , listupdate
functions Příkazy pro správu funkcí User-Defined (UDF) v katalogu Unity:
create, delete, get, , listupdate
grants Příkazy pro udělení přístupu k datům v katalogu Unity:
get, get-effective, update
metastores Příkazy pro správu metastorů, což je kontejner objektů nejvyšší úrovně v katalogu Unity:
assign, create, current, delete, get, list, summary, unassign, update, update-assignment
model-versions Příkazy pro správu verzí modelu Databricks poskytuje hostované verze registru modelů MLflow v katalogu Unity.
delete, get, get-by-alias, , listupdate
online-tables Příkazy pro správu online tabulek, které poskytují nižší latenci a vyšší přístup QPS k datům z tabulek Delta:
create, delete, get
quality-monitors Příkazy pro správu monitorů, které v průběhu času počítají a monitorují metriky kvality dat nebo modelů pro tabulku:
create, delete, get, get-refresh, list-refreshes, , run-refreshupdate
registered-models Příkazy pro správu registrovaných modelů Databricks poskytuje hostované verze registru modelů MLflow v katalogu Unity.
create, delete, delete-alias, get, list, , set-aliasupdate
schemas Příkazy pro správu schémat, která je druhou vrstvou tříúrovňové struktury názvů Unity Catalog:
create, delete, get, , listupdate
storage-credentials Příkazy pro správu přihlašovacích údajů úložiště, což je mechanismus ověřování a autorizace pro přístup k datům uloženým ve vašem cloudovém tenantovi:
create, delete, get, list, , updatevalidate
system-schemas Příkazy pro správu systémových schémat, což jsou schémata, která se nacházejí v systémovém katalogu:
disable, enable, list
table-constraints Příkazy pro správu omezení primárního klíče a cizího klíče, které kódují relace mezi poli v tabulkách:
create, delete
tables Příkazy pro správu tabulek, umístěné ve třetí vrstvě tříúrovňového jmeného prostoru katalogu Unity:
delete, exists, get, , listlist-summaries
volumes Příkazy pro správu svazků, což jsou funkce katalogu Unity (UC) pro přístup, ukládání, řízení, uspořádání a zpracování souborů:
create, delete, list, , readupdate
workspace-bindings Příkazy pro správu vazeb zabezpečeného pracovního prostoru Zabezpečitelné prvky v Databricks je možné nakonfigurovat jako OPEN nebo ISOLATED.
get, get-bindings, , updateupdate-bindings

Příkazy pro Delta sharing

Skupina Popis a příkazy
providers Příkazy pro správu zprostředkovatelů dat, které představují organizace, které sdílejí data:
create, delete, get, list, , list-sharesupdate
recipient-activation Příkazy pro správu aktivace příjemce, které platí pouze v otevřeném modelu sdílení, kde má objekt příjemce typ ověřování TOKEN:
get-activation-url-info, retrieve-token
recipients Příkazy pro správu příjemců, které vytvoříte pomocí :method:recipients/create k reprezentaci organizace, které chcete povolit přístup ke sdílení:
create, delete, get, list, , rotate-tokenupdate
share-permissions
shares Příkazy pro správu sdílených objektů, které jsou instancemi kontejnerů s :method:shares/create:
create, delete, get, , listupdate
share-permissions, update-permissions

Příkazy nastavení

Skupina Popis a příkazy
ip-access-lists Příkazy umožňující správcům konfigurovat přístupové seznamy IP adres:
create, delete, get, list, , replaceupdate
settings Příkazy umožňující uživatelům spravovat nastavení na úrovni pracovního prostoru:
automatic-cluster-update, csp-enablement, default-namespace, , esm-enablementrestrict-workspace-admins
token-management Příkazy, které správcům umožňují získat všechny tokeny a odstranit tokeny pro ostatní uživatele:
create-obo-token, delete, , getlist
get-permission-levels, get-permissions, , set-permissionsupdate-permissions
tokens Příkazy pro vytváření, výpis a odvolávání tokenů, které se dají použít k ověřování a přístupu k rozhraním REST API Databricks:
create, delete, list
workspace-conf Příkazy pro aktualizaci nastavení pracovního prostoru:
get-status, set-status

Příkazy vývojářských nástrojů

Skupina Popis a příkazy
balíček Příkazy pro správu sad prostředků Databricks, které umožňují vyjádřit své projekty Databricks jako kód:
deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate
synchronizace Synchronizujte místní adresář s adresářem pracovního prostoru.

Příkazy pro vektorové vyhledávání

Skupina Popis a příkazy
vector-search-endpoints Příkazy pro správu koncových bodů vektorového vyhledávání, které představují výpočetní prostředky pro hostování indexů vektorového vyhledávání:
create-endpoint, delete-endpoint, , get-endpointlist-endpoints
vector-search-indexes Příkazy pro správu indexů vektorového vyhledávání, efektivní reprezentace zapouzdřovacích vektorů, které podporují vyhledávací dotazy v reálném čase a efektivní vyhledávání přibližných nejbližších sousedů (ANN):
create-index, delete-data-vector-index, delete-index, , get-indexlist-indexes, query-index, , sync-indexupsert-data-vector-index

Příkazy řídicího panelu

Skupina Popis a příkazy
dashboards Příkazy pro úpravy řídicích panelů:
create, delete, get, list, , restoreupdate
lakeview Příkazy, které poskytují konkrétní operace správy pro řídicí panely AI/BI:
create, get, get-published, , migratepublish, trash, , unpublishupdate

Další příkazy

Skupina Popis a příkazy
api Příkazy pro odesílání požadavků na rozhraní REST API Služby Databricks:
delete, get, head, patch, , postput
dokončení Příkazy pro generování skriptu automatického dokončování pro zadanou shell:
bash, fish, , powershellzsh
konfigurovat Nakonfigurujte rozhraní příkazového řádku Databricks.
help Výstupní informace o využití libovolného příkazu
Labs Příkazy pro správu instalací Databricks Labs:
clear-cache, install, installed, list, show, , uninstallupgrade
version Načtěte verzi rozhraní příkazového řádku, která se právě používá.

Globální příznaky

Následující možnosti jsou k dispozici pro všechny příkazy Databricks CLI. Všimněte si, že některé vlajky se na některé příkazy nevztahují. Podrobné informace o konkrétních příkazech a jejich příznakech najdete v nápovědě k příkazovému řádku.

Vlajka 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í balíčkové prostředí k použití pro související příkaz, pokud je to možné.
--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 ve vašem souboru .databrickscfg. Pokud tento příznak není zadán, použije se profil pojmenovaný DEFAULT, pokud existuje. Po Tab nebo --profile můžete stisknout -p, abyste místo ručního zadávání názvu konfiguračního profilu zobrazili seznam existujících dostupných konfiguračních profilů.
--progress-format Formát pro zobrazení protokolů průběhu (default (výchozí) nebo appendinplace nebo json).