Databricks CLI-parancsok
Feljegyzé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 és a Databricks parancssori felületének telepítését vagy frissítését ismertető témakört.
A Databricks PARANCSSOR az alábbi táblákban 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 , mkdir rm |
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 , list update |
repos |
Parancsok, amelyekkel a felhasználók kezelhetik a git-adattáraikat:create , delete , get , list update get-permission-levels , get-permissions , set-permissions update-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-acl get-secret , list-acls , list-scopes , list-secrets , , put-acl put-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-status import , import-dir , list mkdirs get-permission-levels , get-permissions , set-permissions update-permissions |
Számítási parancsok
Csoport | Leírás és parancsok |
---|---|
cluster-policies |
Parancsok a felhasználók fürtök szabálykészleten alapuló konfigurálásának szabályozására:create , delete , edit , get list get-permission-levels , get-permissions , set-permissions update-permissions |
clusters |
Olyan parancsok, amelyek lehetővé teszik fürtök létrehozását, indítását, szerkesztését, listázását, leállítását és törlését:change-owner , create , delete , edit , events get , list , list-node-types , list-zones ,pin resize permanent-delete , restart , , , , start spark-versions unpin get-permission-levels , get-permissions , set-permissions update-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 , list update |
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 , get list get-permission-levels , get-permissions , set-permissions update-permissions |
instance-profiles |
Parancsok, amelyekkel a rendszergazdák felvehetnek, listázhatnak és eltávolíthatnak olyan példányprofilokat, amelyekkel a felhasználók fürtöket indíthatnak:add , edit , list remove |
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 , install uninstall |
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-permissions update-permissions |
Delta Live Tables 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-events list-pipelines , list-updates , start-update , , stop update get-permission-levels , get-permissions , set-permissions update-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 log-metric log-model log-inputs list-experiments log-batch , log-param , , update-experiment restore-experiment restore-run restore-runs search-experiments search-runs set-experiment-tag set-tag update-run get-permission-levels , get-permissions , set-permissions update-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 , transition-stage list-transition-requests list-webhooks list-models get-model-version update-model set-model-tag update-comment rename-model search-model-versions search-models update-model-version get-model set-model-version-tag reject-transition-request get-model-version-download-uri test-registry-webhook delete-transition-request delete-webhook get-latest-versions update-webhook get-permission-levels , get-permissions , set-permissions update-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 , get list , logs , patch , put , , query update-config get-permission-levels , get-permissions , set-permissions update-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 , profiles token |
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 , list patch update |
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 , list patch update |
users |
A Databricks által felismert és e-mail-címek által képviselt felhasználói identitások parancsai:create , delete , get , list patch update get-permission-levels , get-permissions , set-permissions update-permissions |
SQL-hez kapcsolódó parancsok
Csoport | Leírás és parancsok |
---|---|
alerts |
Parancsok a riasztásokon végzett műveletek végrehajtásához:create , delete , get , list update |
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 , list restore update |
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 , get get-workspace-warehouse-config , list , set-workspace-warehouse-config , , start stop get-permission-levels , get-permissions , set-permissions update-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 megosztott 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 , list update |
connections |
Parancsok külső adatforráshoz való kapcsolat létrehozásához:create , delete , get , list update |
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 , list update |
functions |
A Felhasználó által definiált függvények (UDF-ek) kezelésére szolgáló parancsok a Unity Katalógusban:create , delete , get , list update |
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 , get list , summary , unassign , , update update-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 , list update |
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-refresh list-refreshes , run-refresh update |
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 , get list , set-alias update |
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 , list update |
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 , list update validate |
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 , list list-summaries |
volumes |
A kötetek kezelésére szolgáló parancsok, amelyek a Unity Catalog (UC) képes fájlok elérésére, tárolására, szabályozására, rendszerezésére és feldolgozására:create , delete , list , read update |
workspace-bindings |
Biztonságos munkaterület-kötések kezelésére szolgáló parancsok. A Databricks biztonságossá tételei konfigurálhatók OPEN ISOLATED .get , get-bindings , update update-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 , list list-shares update |
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 címzettek kezelésére szolgáló parancsok, amelyeket úgy hoz létre :method:recipients/create , hogy egy olyan szervezetet képviseljen, amely számára engedélyezni szeretné a megosztásokhoz való hozzáférést:create , delete , get , list rotate-token update share-permissions |
shares |
A megosztások kezelésére szolgáló parancsok, amelyek a következővel példányosított tárolók :method:shares/create :create , delete , get , list update 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 , list replace update |
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-enablement restrict-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 , get list get-permission-levels , get-permissions , set-permissions update-permissions |
tokens |
A Databricks REST API-k hitelesítéséhez és eléréséhez használható jogkivonatok létrehozására, listázására és visszavonására szolgáló parancsok: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 init , run , schema , , sync validate |
szinkronizál | 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-endpoint list-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-index list-indexes , query-index , sync-index upsert-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 , list restore update |
lakeview |
Az AI/BI-irányítópultokhoz adott felügyeleti műveleteket biztosító parancsok:create , get , get-published , migrate publish , trash , unpublish update |
További parancsok
Csoport | Leírás és parancsok |
---|---|
api | Parancsok a Databricks REST API-hoz való kérésekhez:delete , get , head , patch post put |
teljesítés | Parancsok az automatikus kiegészítési szkript létrehozásához a megadott rendszerhéjhoz:bash , fish , powershell zsh |
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 , list show , uninstall upgrade |
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.
Jelölő | 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ó parancshoz használandó kötegkörnyezetet képviselő sztring. |
--log-file |
A kimeneti naplók írásához a sztring. 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ő sztring. 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 fájlban használni kívánt nevesített konfigurációs profilt képviselő sztring .databrickscfg . Ha ez a jelölő nincs megadva, akkor a rendszer az DEFAULT elnevezett profilt használja, ha létezik ilyen. A meglévő elérhető konfigurációs profilok listájának megjelenítéséhez vagy Tab után --profile -p lenyomásával 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 inplace json ). |