Megosztás a következőn keresztül:

Databricks CLI-parancsok

  • Cikk

Megjegyzés

Ezek az információk a Databricks CLI 0.205-ös és újabb verzióira vonatkoznak. A Databricks parancssori felülete nyilvános előzetes verzióban érhető el.

A Databricks CLI használatára a Databricks Licenc és a Databricks adatvédelmi nyilatkozata vonatkozik, beleértve a használati adatokra vonatkozó rendelkezéseket is.

Ez a cikk az elérhető Databricks CLI-parancsokról nyújt tájékoztatást. Ez az információ kiegészíti a parancssori súgót. A Databricks parancssori felület telepítésével és használatával kapcsolatos további információkért lásd: A Databricks parancssori felületének telepítése vagy frissítése és Mi a Databricks parancssori felület?.

A Databricks parancssori felület a következő táblázatokban felsorolt parancscsoportokat tartalmazza. A parancscsoportok kapcsolódó parancsokat tartalmaznak, amelyek alparancsokat is tartalmazhatnak. Parancscsoportok, egyéni parancsok vagy alparancsok használati és szintaxisadatainak kimenete:

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

Számos CLI-parancs megfelelteti az Azure Databricks REST API-referenciajában dokumentált műveleteket.

Munkaterületi parancsok

Csoport Leírás és parancsok
Fs Parancsok a fájlok és a fájlrendszer kezeléséhez:
cat, cp, ls, mkdirrm
git-credentials Parancsok személyes hozzáférési jogkivonatok regisztrálásához a Databricks számára a felhasználó nevében végzett műveletekhez:
create, delete, get, listupdate
repos Parancsok, amelyekkel a felhasználók kezelhetik a git-adattáraikat:
create, delete, get, listupdate
get-permission-levels, get-permissions, set-permissionsupdate-permissions
secrets Titkos kódok, titkos kódok hatóköreinek és hozzáférési engedélyeinek kezelésére szolgáló parancsok:
create-scope, delete-acl, delete-scope, delete-secret, get-aclget-secret, list-acls, list-scopes, list-secrets, , put-aclput-secret
workspace A munkaterületen lévő jegyzetfüzetek és mappák listázására, importálására, exportálására és törlésére szolgáló parancsok:
delete, export, export-dir, get-statusimport, import-dir, listmkdirs
get-permission-levels, get-permissions, set-permissionsupdate-permissions

Számítási parancsok

Csoport Leírás és parancsok
cluster-policies Parancsok a felhasználók fürtöknek a szabálykészleten alapuló konfigurálásának irányítására:
create, delete, edit, getlist
get-permission-levels, get-permissions, set-permissionsupdate-permissions
clusters Olyan parancsok, amelyek lehetővé teszik klaszterek létrehozását, indítását, szerkesztését, listázását, befejezését és törlését:
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 Olyan parancsok, amelyek lehetővé teszik a munkaterület rendszergazdái számára, hogy globális inicializálási szkripteket konfiguráljanak a munkaterületükhöz:
create, delete, get, listupdate
instance-pools Parancsok a példánykészletek létrehozására, szerkesztésére, törlésére és listázására használatra kész felhőpéldányok használatával, amelyek csökkentik a fürtindítási és automatikus méretezési időket:
create, delete, edit, getlist
get-permission-levels, get-permissions, set-permissionsupdate-permissions
instance-profiles Parancsok, amelyek lehetővé teszik a rendszergazdák számára, hogy felvegyenek, listázzanak és eltávolítsanak olyan példányprofilokat, amelyekkel a felhasználók fürtöket indíthatnak:
add, edit, listremove
libraries Parancsok a fürtön lévő kódtárak telepítéséhez, eltávolításához és állapotának lekéréséhez:
all-cluster-statuses, cluster-status, installuninstall
policy-families Az elérhető házirendcsaládok megtekintésére szolgáló parancsok:
get, list

Feladatok parancsai

Csoport Leírás és parancsok
jobs Feladatok kezelésére szolgáló parancsok:
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

DLT-parancsok

Csoport Leírás és parancsok
pipelines Parancsok a folyamatok részleteinek létrehozásához, szerkesztéséhez, törléséhez, elindításához és megtekintéséhez:
create, delete, get, get-update, list-pipeline-eventslist-pipelines, list-updates, start-update, , stopupdate
get-permission-levels, get-permissions, set-permissionsupdate-permissions

Machine Learning-parancsok

Csoport Leírás és parancsok
experiments A kísérletekkel való interakció parancsai, amelyek az MLflow elsődleges szervezeti egységei; az összes MLflow-futtatás egy kísérlethez tartozik:
create-experiment, create-run, delete-experiment, delete-run, delete-runs, delete-tag, get-by-name, get-experiment, get-history, get-runGet, list-artifacts, list-experiments, log-batch, log-inputs, log-metric, log-model, log-param, restore-experiment, restore-run, restore-runs, search-experiments, search-runs, set-experiment-tag, set-tag, update-experiment, update-run
get-permission-levels, get-permissions, set-permissionsupdate-permissions
model-registry A munkaterületmodell beállításjegyzékének parancsai:
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

Parancsok valós idejű kiszolgálása

Csoport Leírás és parancsok
serving-endpoints Végpontokat kiszolgáló modell létrehozására, frissítésére és törlésére szolgáló parancsok:
build-logs, create, delete, export-metrics, getlist, logs, patch, put, , queryupdate-config
get-permission-levels, get-permissions, set-permissionsupdate-permissions

Identitás- és hozzáférés-kezelési parancsok

Csoport Leírás és parancsok
account A Databricks-fiókok kezelésére szolgáló parancsok:
  • Identitás és hozzáférés: access-control, groups, service-principals, users, workspace-assignment
  • Unity Catalog: metastore-assignments, metastores, storage-credentials
  • Beállítások: ip-access-lists, network-connectivity, settings
  • Kiépítés: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces
  • Számlázás: billable-usage, log-delivery
  • OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
Auth Hitelesítési parancsok:
describe, env, login, profilestoken
current-user Parancsok a jelenleg hitelesített felhasználóval vagy szolgáltatásnévvel kapcsolatos információk lekéréséhez:
me
groups Az identitáskezelést egyszerűsítő csoportok parancsai, amelyek megkönnyítik a Hozzáférés hozzárendelését a Databricks-munkaterülethez, az adatokhoz és más biztonságos objektumokhoz:
create, delete, get, listpatchupdate
permissions Olvasási, írási, szerkesztési, frissítési és kezelési parancsok különböző objektumokon és végpontokon lévő különböző felhasználók számára:
get set update
get-permission-levels
service-principals Parancsok a feladatokhoz, automatizált eszközökhöz és rendszerekhez, például szkriptekhez, alkalmazásokhoz és CI/CD-platformokhoz használható identitásokhoz:
create, delete, get, listpatchupdate
users A Databricks által felismert és e-mail-címek által képviselt felhasználói identitások parancsai:
create, delete, get, listpatchupdate
get-permission-levels, get-permissions, set-permissionsupdate-permissions
Csoport Leírás és parancsok
alerts Parancsok a riasztásokon végzett műveletek végrehajtásához:
create, delete, get, listupdate
data-sources Új lekérdezési objektumok létrehozására szolgáló parancsok:
list
queries Parancsok a lekérdezésdefiníciókon végzett műveletek végrehajtásához:
create, delete, get, listrestoreupdate
query-history Parancsok a lekérdezések előzményeihez sql-raktárakon keresztül:
list
warehouses Az SQL-raktárak kezelésére szolgáló parancsok, amelyek egy számítási erőforrás, amellyel SQL-parancsokat futtathat adatobjektumokon a Databricks SQL-ben:
create, delete, edit, getget-workspace-warehouse-config, list, set-workspace-warehouse-config, , startstop
get-permission-levels, get-permissions, set-permissionsupdate-permissions

Unity Catalog-parancsok

Csoport Leírás és parancsok
artifact-allowlists Az összetevők engedélyezési listáinak kezelésére szolgáló parancsok. A Databricks Runtime 13.3-ban és újabb verziókban kódtárakat és init-szkripteket adhat hozzá az UC engedélyezési listájához, hogy a felhasználók a standard hozzáférési móddal konfigurált számításon használhassák ezeket az összetevőket:
get, update
catalogs A katalógusok kezelésére szolgáló parancsok, a Unity Catalog háromszintű névterének első rétege:
create, delete, get, listupdate
connections Parancsok külső adatforráshoz való kapcsolat létrehozásához:
create, delete, get, listupdate
external-locations A külső helyek kezelésére szolgáló parancsok, amelyek a felhőbeli tároló elérési útját egy olyan tároló hitelesítő adatokkal kombinálják, amelyek engedélyezik a felhőbeli tárolási elérési úthoz való hozzáférést:
create, delete, get, listupdate
functions Parancsok User-Defined függvények (UDF-ek) kezeléséhez a Unity Catalogban:
create, delete, get, listupdate
grants Parancsok az adatokhoz való hozzáférés biztosításához a Unity Katalógusban:
get get-effective update
metastores Metaadattárak kezelésére szolgáló parancsok, amelyek a Unity Catalog objektumainak legfelső szintű tárolói:
assign, create, current, delete, getlist, summary, unassign, , updateupdate-assignment
model-versions A modellverziók kezelésére szolgáló parancsok. A Databricks az MLflow modellregisztrációs adatbázis egy üzemeltetett verzióját biztosítja a Unity Catalogban.
delete, get, get-by-alias, listupdate
online-tables Az online táblák kezelésére szolgáló parancsok, amelyek alacsonyabb késést és magasabb QPS-hozzáférést biztosítanak a Delta-táblákból származó adatokhoz:
create delete get
quality-monitors A monitorok kezelésére szolgáló parancsok, amelyek egy tábla adatait vagy modellminőségi mérőszámait számítják ki és figyelik az idő függvényében:
create, delete, get, get-refreshlist-refreshes, run-refreshupdate
registered-models A regisztrált modellek kezelésére szolgáló parancsok. A Databricks az MLflow modellregisztrációs adatbázis egy üzemeltetett verzióját biztosítja a Unity Catalogban.
create, delete, delete-alias, getlist, set-aliasupdate
schemas Sémák kezelésére szolgáló parancsok, amelyek a Unity Catalog háromszintű névterének második rétegét képezik:
create, delete, get, listupdate
storage-credentials A tárolási hitelesítő adatok kezelésére szolgáló parancsok, amelyek a felhőbeli bérlőn tárolt adatokhoz való hozzáférés hitelesítési és engedélyezési mechanizmusai:
create, delete, get, listupdatevalidate
system-schemas A rendszerséma kezelésére szolgáló parancsok, amelyek a rendszerkatalógusban található sémák:
disable enable list
table-constraints A táblák mezői közötti kapcsolatokat kódoló elsődleges kulcs- és idegenkulcs-korlátozások kezelésére szolgáló parancsok:
create, delete
tables A Unity Catalog háromszintű névterének harmadik rétegében található táblák kezelésére szolgáló parancsok:
delete, exists, get, listlist-summaries
volumes A kötetek kezelésére szolgáló parancsok, amelyek a Unity Catalog (UC) képességei közé tartoznak, és hozzáférést, tárolást, szabályozást, rendszerezést és fájlok feldolgozását teszik lehetővé.
create, delete, list, readupdate
workspace-bindings Biztonságos munkaterület-kötések kezelésére szolgáló parancsok. A Databricks védett elemei konfigurálhatók OPEN vagy ISOLATED.
get, get-bindings, updateupdate-bindings

Delta-megosztási parancsok

Csoport Leírás és parancsok
providers Az adatokat megosztó szervezeteket képviselő adatszolgáltatók kezelésére szolgáló parancsok:
create, delete, get, listlist-sharesupdate
recipient-activation A címzettek aktiválásának kezelésére szolgáló parancsok, amelyek csak akkor alkalmazhatók a nyílt megosztási modellben, ha a címzett objektum a TOKEN hitelesítési típussal rendelkezik:
get-activation-url-info, retrieve-token
recipients A :method:recipients/create használatával létrehozott címzettek kezelésére szolgáló parancsok egy olyan szervezetet jelölnek, amelynek engedélyezni szeretné a megosztásokhoz való hozzáférést:
create, delete, get, listrotate-tokenupdate
share-permissions
shares A megosztásokat kezelő parancsok, amelyek a :method:shares/create-val példányosított tárolókra vonatkoznak.
create, delete, get, listupdate
share-permissions, update-permissions

Beállítások parancsai

Csoport Leírás és parancsok
ip-access-lists Parancsok, amelyek lehetővé teszik a rendszergazdák számára az IP-hozzáférési listák konfigurálását:
create, delete, get, listreplaceupdate
settings Parancsok, amelyekkel a felhasználók a munkaterület szintjén kezelhetik a beállításokat:
automatic-cluster-update, csp-enablement, default-namespace, esm-enablementrestrict-workspace-admins
token-management Olyan parancsok, amelyek lehetővé teszik a rendszergazdák számára az összes jogkivonat lekérését és a jogkivonatok törlését más felhasználók számára:
create-obo-token, delete, getlist
get-permission-levels, get-permissions, set-permissionsupdate-permissions
tokens Parancsok tokenek létrehozására, listázására és visszavonására, amelyek a Databricks REST API-k hitelesítésére és elérésére használhatók.
create delete list
workspace-conf Parancsok a munkaterület beállításainak frissítéséhez:
get-status, set-status

Fejlesztői eszközök parancsok

Csoport Leírás és parancsok
csomag A Databricks-eszközcsomagok kezelésére szolgáló parancsok, amelyek lehetővé teszik a Databricks-projektek kódként való kifejezését:
deploy, deployment, destroy, generate, initopen, run, schema, summary, , syncvalidate
szinkronizálás Helyi címtár szinkronizálása munkaterület-címtárral.

Vektorkeresési parancsok

Csoport Leírás és parancsok
vector-search-endpoints Vektorkeresési végpontok kezelésére szolgáló parancsok, amelyek a vektorkeresési indexek üzemeltetéséhez szükséges számítási erőforrásokat jelölik:
create-endpoint, delete-endpoint, get-endpointlist-endpoints
vector-search-indexes A vektorkeresési indexek kezelésére szolgáló parancsok, a beágyazási vektorok hatékony ábrázolása, amely támogatja a valós idejű és hatékony közelítő közelítő (ANN) keresési lekérdezéseket:
create-index, delete-data-vector-index, delete-index, get-indexlist-indexes, query-index, sync-indexupsert-data-vector-index

Irányítópult-parancsok

Csoport Leírás és parancsok
dashboards Irányítópultok módosítására szolgáló parancsok:
create, delete, get, listrestoreupdate
lakeview Az AI/BI-irányítópultokhoz adott felügyeleti műveleteket biztosító parancsok:
create, get, get-published, migratepublish, trash, unpublishupdate

További parancsok

Csoport Leírás és parancsok
api Parancsok a Databricks REST API-hoz való kérésekhez:
delete, get, head, patchpostput
teljesítés Parancsok az automatikus kiegészítési szkript létrehozásához a meghatározott shellhez:
bash, fish, powershellzsh
konfigurál Konfigurálja a Databricks parancssori felületét.
help Bármely parancs kimeneti használati adatai.
Labs A Databricks Labs-telepítések kezelésére szolgáló parancsok:
clear-cache, install, installed, listshow, uninstallupgrade
version Kérje le a jelenleg használt parancssori felület verzióját.

Globális jelzők

Az alábbi jelzők az összes Databricks CLI-parancs számára elérhetők. Vegye figyelembe, hogy egyes jelölők egyes parancsokra nem vonatkoznak. Az egyes parancsokkal és jelzőkkel kapcsolatos részletes információkért tekintse meg a parancssori súgót.

Zászló Leírás
-h vagy --help Súgó megjelenítése a Databricks parancssori felületéhez, a kapcsolódó parancscsoporthoz vagy a kapcsolódó parancshoz.
-e vagy --environment string A kapcsolódó parancs esetén használatos kötegkörnyezetet képviselő karakterlánc.
--log-file Egy karakterlánc, amely leírja, hogy hova kell írni a kimeneti naplókat. Ha ez a jelző nincs megadva, akkor az alapértelmezett beállítás a kimeneti naplók stderrbe írása.
--log-format text a kimeneti naplók szövegbe írásához vagy json a kimeneti naplók JSON-ba való írásához. Ha ez a jelző nincs megadva, a kimeneti naplók szövegként lesznek megírva.
--log-level A naplóformátum szintjét képviselő karakterlánc. Ha nincs megadva, a naplóformátum szintje le van tiltva.
-o vagy --output text a kimenet szövegként való írásához vagy json a kimenet JSON-ként való írásához. Ha ez a jelző nincs megadva, a kimenet szövegként lesz megírva.
-p vagy --profile A .databrickscfg fájlban használni kívánt konfigurációs profilt megadó karakterlánc. Ha ez a jelölő nincs megadva, akkor a rendszer az DEFAULT elnevezett profilt használja, ha létezik ilyen. A Tab vagy --profile után a -p lenyomva megjelenítheti a meglévő elérhető konfigurációs profilok listáját, amely közül választhat a konfigurációs profil nevének manuális megadása helyett.
--progress-format A folyamatnaplók megjelenítendő formátuma (default (az alapértelmezett) vagy append a inplacejson).