Příkazy 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í.

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

Group	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-secretget-aclget-secretlist-aclslist-scopeslist-secrets, put-aclput-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

Group	Popis a příkazy
zásady clusteru	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
fondy instancí	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
profily instancí	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
knihovny	Příkazy pro instalaci, odinstalaci a získání stavu knihoven v clusteru: all-cluster-statuses, cluster-status, , installuninstall
soubor zásad	Příkazy pro zobrazení dostupných kategorií zásad: get, list

Příkazy úloh

Group	Popis a příkazy
jobs	Příkazy pro správu úloh: cancel-all-runs, cancel-run, , , createdeletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy deklarativních kanálů Sparku pro Lakeflow

Group	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-updatelist-pipeline-events, list-pipelineslist-updatesstart-update, , stopupdate get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy služby Machine Learning

Group	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
vývoj funkcí	Příkazy pro interakci s funkcemi v úložišti funkcí Databricks, které poskytují centrální registr pro funkce používané v modelech AI a ML. create-feature, delete-feature, get-feature, , list-featuresupdate-feature
registr modelů	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

Group	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-metricsgetlistlogspatchput, queryupdate-config get-permission-levels, get-permissions, , set-permissionsupdate-permissions

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

Group	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
aktuální-uživatel	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
objekty zástupce služby	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

Příkazy související s SQL

Group	Popis a příkazy
alerts	Příkazy pro provádění operací s upozorněními: create, delete, get, , listupdate
Upozornění – starší verze	Příkazy pro provádění operací se staršími upozorněními: create, delete, get, , listupdate
zdroje dat	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
dotazy – starší verze	Příkazy pro provádění operací s definicemi starší verze dotazu: create, delete, get, list, , restoreupdate
historie dotazů	Příkazy pro přístup k historii dotazů prostřednictvím SQL Warehouse: list
sklady	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, , editgetget-workspace-warehouse-configlistset-workspace-warehouse-config, , startstop get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Příkazy katalogu Unity

Group	Popis a příkazy
seznamy povolených artefaktů	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ů, které představují první vrstvu tříúrovňového oboru názvů Unity Catalog: create, delete, get, , listupdate
pověření	Příkazy pro správu přihlašovacích údajů, což je mechanismus ověřování a autorizace pro přístup ke službám ve vašem cloudovém tenantovi. Na každé přihlašovací údaje se vztahují zásady řízení přístupu katalogu Unity, které určují, kteří uživatelé a skupiny mají přístup k přihlašovacím údajům. create-credential, delete-credential, generate-temporary-service-credential, get-credential, list-credentials, , update-credentialvalidate-credential
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 uživatelem definovaných funkcí (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
metastore	Příkazy pro správu metastorů, což je kontejner objektů nejvyšší úrovně v katalogu Unity: assign, create, , current, deleteget, listsummaryunassign, , updateupdate-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 tabulky	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
monitorování kvality	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
registrované modely	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
kvóty prostředků	Příkazy pro správu kvót prostředků vynucovaných službou Unity Catalog pro všechny zabezpečitelné objekty, které omezují počet prostředků, které lze vytvořit. get-quota, list-quotas
schemas	Příkazy pro správu schémat, která tvoří druhou vrstvu tříúrovňového jmenného prostoru katalogu Unity. 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
systémová schémata	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
omezení tabulky	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, které jsou umístěny ve třetí vrstvě tříúrovňového prostoru názvů katalogu Unity. delete, exists, get, , listlist-summaries
temporary-table-credentials	Příkazy pro správu dočasných přihlašovacích údajů tabulky, které jsou krátkodobé, omezené přihlašovací údaje používané pro přístup k cloudovým úložným lokalitám, kde jsou data tabulek uložená v Databricks. generate-temporary-table-credentials
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
Vazby pracovního prostoru	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

Group	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
aktivace příjemcem	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
příjemci	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
sdílení	Příkazy pro správu sdílených objektů, které jsou instancemi kontejnerů s :method:shares/create: create, delete, get, list, , list-sharesupdate share-permissions, update-permissions

Příkazy nastavení

Group	Popis a příkazy
seznamy pro přístup IP	Příkazy umožňující správcům konfigurovat přístupové seznamy IP adres: create, delete, get, list, , replaceupdate
cíle oznámení	Příkazy pro správu oznámení cílů pracovní prostor: create, delete, get, , listupdate
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
správa tokenů	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
tokeny	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ů

Group	Popis a příkazy
bundle	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, plan, run, schema, summary, sync, validate
sync	Synchronizujte místní adresář s adresářem pracovního prostoru.

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

Group	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

Group	Popis a příkazy
dashboards	Příkazy pro úpravy starších řídicích panelů: create, delete, get, list, , restoreupdate
genie	Příkazy pro úpravu Genie, které poskytují firemním uživatelům prostředí bez kódu s využitím AI/BI: create-message, execute-message-attachment-query, get-message, get-message-attachment-query-result, , get-spacedstart-conversation
Lakeview	Příkazy, které poskytují konkrétní operace správy pro řídicí panely AI/BI: create, create-schedule, , create-subscription, delete-schedule, delete-subscriptiongetget-publishedget-scheduleget-subscriptionlistlist-scheduleslist-subscriptionsmigratepublishtrashunpublish, updateupdate-schedule

Příkazy Marketplace

Group	Popis a příkazy
realizace pro spotřebitele	Příkazy pro správu plnění, což jsou entity, které umožňují spotřebitelům náhled instalací. get, list
spotřebitelské instalace	Příkazy pro správu instalací, což jsou entity, které uživatelům umožňují interakci se výpisy z Marketplace Databricks. create, delete, list, , list-listing-installationsupdate
výpisy uživatelů	Příkazy pro správu výpisů příjemců z Databricks Marketplace: batch-get, get, , listsearch
žádosti o personalizaci pro spotřebitele	Příkazy pro správu žádostí o přizpůsobení, které zákazníkům umožňují interagovat s individuálním procesem vytváření příspěvků na Marketplace. create get list
spotřebitelé-poskytovatelé	Příkazy pro správu poskytovatelů, což jsou entity, které publikují výpisy na Marketplace. batch-get get list
filtry pro výměnu poskytovatelů	Příkazy pro správu filtrů výměn z Marketplace, které kurátorují, které skupiny mají přístup k výměně. create, delete, , listupdate
výměny poskytovatelů	Příkazy pro správu výměn na Marketplace, které poskytovatelům umožňují sdílet své nabídky s kurátorovanou skupinou zákazníků. add-listing-to-exchange, create, , deletedelete-listing-from-exchangegetlistlist-exchanges-for-listing, , list-listings-for-exchangeupdate
soubory poskytovatele	Příkazy pro správu souborů Marketplace, jako jsou poznámkové bloky preview a ikony poskytovatelů create, delete, , getlist
výpisy poskytovatelů	Příkazy pro správu výpisů zprostředkovatelů: create, delete, get, , listupdate
požadavky na personalizaci poskytovatele	Příkazy pro správu žádostí o přizpůsobení, které jsou alternativou k okamžitě dostupným výpisům. list, update
poskytovatel-poskytovatel-analytické-nástěnky	Příkazy pro správu šablonované analýzy pro poskytovatele: create, get, , get-latest-versionupdate
poskytovatel-poskytovatelé	Příkazy pro správu poskytovatelů, které spravují prostředky na Marketplace. create, delete, get, , listupdate

Příkazy aplikací

Group	Popis a příkazy
apps	Příkazy pro správu aplikací Databricks, které běží přímo na vaší instanci Databricks, integrují se s vašimi daty, používají a rozšiřují služby Databricks a umožňují uživatelům komunikovat prostřednictvím jednotného přihlašování. create, delete, , deploy, getget-deploymentlistlist-deploymentsrun-localstart, stopupdate

Příkazy vyčištění místností

Group	Popis a příkazy
prostředky čisté místnosti	Příkazy pro správu prostředků čistého prostoru, které jsou objekty dat a kódu, jako například tabulky, svazky a poznámkové bloky sdílené s čistým prostorem. create, delete, get, , listupdate
úlohy v čistém prostředí	Příkazy k řízení provádění úloh v čisté místnosti, což jsou provádění poznámkových bloků ve sterilním prostředí. list
čisté pokoje	Příkazy pro správu čistých místností Čisté místnosti používají funkci Delta Sharing a bezserverové výpočetní prostředky k zajištění zabezpečeného a chráněného prostředí ochrany osobních údajů, ve kterém může více stran spolupracovat na citlivých podnikových datech bez přímého přístupu k datům ostatních. create, create-output-catalog, delete, get, , listupdate

Databázové příkazy

Group

Popis a příkazy

databáze

Příkazy pro správu instancí databáze Lakebase create-database-catalog, create-database-instance, , , create-database-tablecreate-synced-database-tabledelete-database-catalogdelete-database-instancedelete-database-tabledelete-synced-database-tablefind-database-instance-by-uidgenerate-database-credentialget-database-catalogget-database-instanceget-database-tableget-synced-database-tablelist-database-instancesupdate-database-instance

Další příkazy

Group	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
completion	Příkazy pro generování skriptu automatického dokončování pro zadanou shell: bash, fish, , powershellzsh
configure	Nakonfigurujte rozhraní příkazového řádku Databricks.
help	Souhrnné informace výstupu pro všechny příkazy rozhraní příkazového řádku Databricks
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.

--debug

  Zda povolit protokolování ladění.

-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

--log-file řetězec

    Řetězec představující soubor, do kterého se zapisují výstupní protokoly. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.

--log-format formát

    Typ formátu protokolu, text nebo json. Výchozí hodnota je text.

--log-level řetězec

    Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.

-o, --output typ

    Typ výstupu příkazu, text nebo json. Výchozí hodnota je text.

-p, --profile řetězec

    Název profilu v ~/.databrickscfg souboru, který se má použít ke spuštění příkazu. Pokud tento příznak není zadán, použije se profil s názvem DEFAULT, pokud existuje.

--progress-format formát

    Formát pro zobrazení protokolů průběhu: default, append, inplacenebo json

-t, --target řetězec

    Pokud je to relevantní, cílový balíček, který se má použít