Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Note
Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.
Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.
Den här artikeln innehåller information om tillgängliga Databricks CLI-kommandon. Den här informationen kompletterar kommandoradshjälpen. Mer information om hur du installerar och använder Databricks CLI finns i Installera eller uppdatera Databricks CLI och Vad är Databricks CLI?.
Databricks CLI innehåller de kommandogrupper som anges i följande tabeller. Kommandogrupper innehåller uppsättningar med relaterade kommandon, som också kan innehålla underkommandon. Så här matar du ut användnings- och syntaxinformation för en kommandogrupp, ett enskilt kommando eller en underkommando:
databricks <command-group> -hdatabricks <command-group> <command-name> -hdatabricks <command-group> <command-name> <subcommand-name> -h
Många CLI-kommandon mappas till åtgärder som dokumenteras i REST API-referensen för Azure Databricks.
Kommandon för arbetsyta
| Group | Beskrivning och kommandon |
|---|---|
| fs | Kommandon för att hantera filer och filsystemet:cat, cp, ls, , , mkdirrm |
| git-autentiseringsuppgifter | Kommandon för att registrera personliga åtkomsttoken för Databricks för att utföra åtgärder för användarens räkning:create, delete, get, , , listupdate |
| repos | Kommandon för att tillåta användare att hantera sina git-lagringsplatser:create, delete, get, , , listupdateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| secrets | Kommandon för att hantera hemligheter, hemliga omfång och åtkomstbehörigheter:create-scope, delete-acl, delete-scope, delete-secret, get-acl, get-secret, , list-acls, list-scopes, list-secrets, , , put-aclput-secret |
| workspace | Kommandon för att lista, importera, exportera och ta bort anteckningsböcker och mappar på arbetsytan:delete, export, export-dir, get-status, import, , import-dir, , listmkdirsget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Beräkningskommandon
| Group | Beskrivning och kommandon |
|---|---|
| klusterprinciper | Kommandon för att styra användarnas möjlighet att konfigurera kluster baserat på en uppsättning regler:create, delete, edit, , , getlistget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| clusters | Kommandon som gör att du kan skapa, starta, redigera, lista, avsluta och ta bort kluster:change-owner, create, delete, edit, events, get, list, list-node-types, list-zones, permanent-delete,pin, resize, , restart, spark-versions, , startunpinget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| global-init-scripts | Kommandon som gör det möjligt för arbetsyteadministratörer att konfigurera globala initieringsskript för arbetsytan:create, delete, get, , , listupdate |
| instanspooler | Kommandon för att skapa, redigera, ta bort och lista instanspooler med hjälp av molninstanser som är redo att användas, vilket minskar start- och automatisk skalningstider för ett kluster:create, delete, edit, , , getlistget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| instansprofiler | Kommandon som gör det möjligt för administratörer att lägga till, lista och ta bort instansprofiler som användare kan starta kluster med:add, edit, , listremove |
| bibliotek | Kommandon för att installera, avinstallera och hämta status för bibliotek i ett kluster:all-cluster-statuses, cluster-status, , installuninstall |
| policy-families | Kommandon för att visa tillgängliga principfamiljer:get, list |
Jobbkommandon
| Group | Beskrivning och kommandon |
|---|---|
| jobs | Kommandon för att hantera jobb: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, , submitupdateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Lakeflow deklarativa rörledningskommandon
| Group | Beskrivning och kommandon |
|---|---|
| pipelines | Kommandon för att skapa, redigera, ta bort, starta och visa information om pipelines:create, delete, get, get-update, list-pipeline-events, list-pipelines, , list-updates, start-update, , stopupdateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Machine Learning-kommandon
| Group | Beskrivning och kommandon |
|---|---|
| experiments | Kommandon för att interagera med experiment, som är den primära organisationsenheten i MLflow; alla MLflow-körningar tillhör ett experiment: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-runsset-experiment-tag, set-tag, update-experimentupdate-runget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| model-registry | Kommandon för arbetsytans modellregister: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-webhookget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Kommandon för realtidsservering
| Group | Beskrivning och kommandon |
|---|---|
| serveringsslutpunkter | Kommandon för att skapa, uppdatera och ta bort modell som betjänar slutpunkter:build-logs, create, delete, export-metrics, get, list, , logs, patch, put, , , queryupdate-configget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Identitets- och åtkomsthanteringskommandon
| Group | Beskrivning och kommandon |
|---|---|
| account | Kommandon för att hantera Databricks-konton:
|
| auth | Kommandon för autentisering:describe, env, login, , , profilestoken |
| current-user | Kommandon för att hämta information om för närvarande autentiserad användare eller tjänstens huvudnamn:me |
| groups | Kommandon för grupper som förenklar identitetshantering, vilket gör det enklare att tilldela åtkomst till Databricks-arbetsyta, data och andra skyddsbara objekt:create, delete, get, list, , , patchupdate |
| permissions | Kommandon för att skapa läs-, skriv-, redigerings-, uppdaterings- och hanteringsåtkomst för olika användare på olika objekt och slutpunkter:get, , setupdateget-permission-levels |
| tjänstens huvudnamn | Kommandon för identiteter för användning med jobb, automatiserade verktyg och system som skript, appar och CI/CD-plattformar:create, delete, get, list, , , patchupdate |
| users | Kommandon för användaridentiteter som identifieras av Databricks och representeras av e-postadresser:create, delete, get, list, , , patchupdateget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
SQL-relaterade kommandon
| Group | Beskrivning och kommandon |
|---|---|
| alerts | Kommandon för att utföra åtgärder på aviseringar:create, delete, get, , , listupdate |
| alerts-legacy | Kommandon för att utföra åtgärder på äldre aviseringar:create, delete, get, , , listupdate |
| datakällor | Kommandon för att skapa nya frågeobjekt:list |
| queries | Kommandon för att utföra åtgärder på frågedefinitioner:create, delete, get, list, , , restoreupdate |
| queries-legacy | Kommandon för att utföra åtgärder på äldre frågedefinitioner:create, delete, get, list, , , restoreupdate |
| query-history | Kommandon för att komma åt historiken för frågor via SQL-lager:list |
| Lager | Kommandon för att hantera SQL-lager, som är en beräkningsresurs som gör att du kan köra SQL-kommandon på dataobjekt i Databricks SQL:create, delete, edit, get, get-workspace-warehouse-config, list, , set-workspace-warehouse-config, , startstopget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
Unity Catalog-kommandon
| Group | Beskrivning och kommandon |
|---|---|
| artifact-allowlists | Kommandon för att hantera listor över tillåtna artefakter. I Databricks Runtime 13.3 och senare kan du lägga till bibliotek och init-skript i listan över tillåtna i UC så att användarna kan utnyttja dessa artefakter vid beräkning som konfigurerats med standardåtkomstläge:get, update |
| catalogs | Kommandon för att hantera kataloger, det första lagret i Unity Catalogs namnområde på tre nivåer:create, delete, get, , , listupdate |
| Autentiseringsuppgifter | Kommandon för att hantera autentiseringsuppgifter, som är autentiserings- och auktoriseringsmekanismen för åtkomst till tjänster i din molnklientorganisation. Varje autentiseringsuppgift omfattas av åtkomstkontrollprinciper för Unity Catalog som styr vilka användare och grupper som kan komma åt autentiseringsuppgifterna.create-credential, delete-credential, generate-temporary-service-credential, get-credential, list-credentials, , , update-credentialvalidate-credential |
| connections | Kommandon för att skapa en anslutning till en extern datakälla:create, delete, get, , , listupdate |
external-locations |
Kommandon för att hantera externa platser, som kombinerar en molnlagringssökväg med en lagringsautentiseringsuppgift som ger åtkomst till molnlagringssökvägen:create, delete, get, , , listupdate |
| functions | Kommandon för att hantera användardefinierade funktioner (UDF:er) i Unity Catalog:create, delete, get, , , listupdate |
| grants | Kommandon för att bevilja åtkomst till data i Unity Catalog:get, , get-effectiveupdate |
| metaarkiv | Kommandon för att hantera metaarkiv, som är den översta containern för objekt i Unity Catalog:assign, create, current, delete, get, list, , summary, unassign, , updateupdate-assignment |
| modellversioner | Kommandon för att hantera modellversioner. Databricks tillhandahåller en värdbaserad version av MLflow Model Registry i Unity Catalog.delete, get, get-by-alias, , , listupdate |
| online-tabeller | Kommandon för att hantera onlinetabeller, vilket ger kortare svarstid och högre QPS-åtkomst till data från Delta-tabeller:create, , deleteget |
| kvalitetsövervakare | Kommandon för att hantera övervakare, som beräknar och övervakar data eller modellkvalitetsmått för en tabell över tid:create, delete, get, get-refresh, list-refreshes, , , run-refreshupdate |
| registered-models | Kommandon för att hantera registrerade modeller. Databricks tillhandahåller en värdbaserad version av MLflow Model Registry i Unity Catalog.create, delete, delete-alias, get, list, , , set-aliasupdate |
| resurskvoter | Kommandon för att hantera resurskvoter som tillämpas av Unity Catalog på alla skyddsbara objekt, vilket begränsar antalet resurser som kan skapas.get-quota, list-quotas |
| schemas | Kommandon för att hantera scheman, som är det andra lagret i Unity Catalogs namnområde på tre nivåer:create, delete, get, , , listupdate |
| autentiseringsuppgifter för lagring | Kommandon för att hantera autentiseringsuppgifter för lagring, som är en autentiserings- och auktoriseringsmekanism för åtkomst till data som lagras i molnklientorganisationen:create, delete, get, list, , , updatevalidate |
| systemscheman | Kommandon för att hantera systemscheman, som är scheman som finns i systemkatalogen:disable, , enablelist |
| tabellbegränsningar | Kommandon för att hantera begränsningar för primärnyckel och sekundärnyckel som kodar relationer mellan fält i tabeller:create, delete |
| tables | Kommandon för att hantera tabeller, som finns i det tredje lagret i Unity Catalogs namnområde på tre nivåer:delete, exists, get, , , listlist-summaries |
| temporary-table-credentials | Kommandon för att hantera tillfälliga autentiseringsuppgifter för tabeller, som är kortlivade, nedkopierade autentiseringsuppgifter som används för att komma åt molnlagringsplatser där tabelldata lagras i Databricks.generate-temporary-table-credentials |
| volumes | Kommandon för att hantera volymer, som är en Unity Catalog-funktion (UC) för åtkomst, lagring, styrning, organisering och bearbetning av filer:create, delete, list, , , readupdate |
| bindningar för arbetsytor | Kommandon för att hantera bindningar för säkra arbetsytor. Skyddsbara i Databricks kan konfigureras som OPEN eller ISOLATED.get, get-bindings, , updateupdate-bindings |
Deltadelningskommandon
| Group | Beskrivning och kommandon |
|---|---|
| providers | Kommandon för att hantera dataprovidrar, som representerar de organisationer som delar data:create, delete, get, list, , , list-sharesupdate |
| mottagaraktivering | Kommandon för att hantera mottagaraktivering, vilket endast gäller i den öppna delningsmodellen där mottagarobjektet har typen TOKEN-autentisering:get-activation-url-info, retrieve-token |
| Mottagare | Kommandon för att hantera mottagare som du skapar för att använda :method:recipients/create för att representera en organisation som du vill tillåta åtkomst till delningar:create, delete, get, list, , , rotate-tokenupdateshare-permissions |
| Aktier | Kommandon för att hantera resurser, som är containrar som instansieras med :method:shares/create:create, delete, get, , , listupdateshare-permissions, update-permissions |
Inställningskommandon
| Group | Beskrivning och kommandon |
|---|---|
| ip-access-lists | Kommandon för att göra det möjligt för administratörer att konfigurera IP-åtkomstlistor:create, delete, get, list, , , replaceupdate |
| notification-destinations | Kommandon för att hantera en arbetsytas notifikationsdestinationer:create, delete, get, , , listupdate |
| settings | Kommandon som gör det möjligt för användare att hantera inställningar på arbetsytans nivå:automatic-cluster-update, csp-enablement, default-namespace, , , esm-enablementrestrict-workspace-admins |
| tokenhantering | Kommandon som gör det möjligt för administratörer att hämta alla token och ta bort token för andra användare:create-obo-token, delete, , getlistget-permission-levels, get-permissions, , set-permissionsupdate-permissions |
| Token | Kommandon för att skapa, lista och återkalla token som kan användas för att autentisera och komma åt Databricks REST-API:er:create, , deletelist |
| workspace-conf | Kommandon för att uppdatera arbetsyteinställningar:get-status, set-status |
Utvecklarverktygens kommandon
| Group | Beskrivning och kommandon |
|---|---|
| bundle | Kommandon för att hantera Databricks-tillgångspaket, som gör att du kan uttrycka dina Databricks-projekt som kod:deploy, deployment, destroy, generate, init, open, , run, schema, summary, , , syncvalidate |
| sync | Synkronisera en lokal katalog till en arbetsytekatalog. |
Vektorsökningskommandon
| Group | Beskrivning och kommandon |
|---|---|
| vector-search-endpoints | Kommandon för att hantera slutpunkter för vektorsökning, som representerar beräkningsresurserna för att vara värd för vektorsökningsindex:create-endpoint, delete-endpoint, , get-endpointlist-endpoints |
| vector-search-indexes | Kommandon för att hantera vektorsökningsindex, en effektiv representation av dina inbäddningsvektorer som stödjer realtids- och effektiv ungefärlig närmaste granne-sökfrågor:create-index, delete-data-vector-index, delete-index, get-index, list-indexes, , query-index, , sync-indexupsert-data-vector-index |
Instrumentpanelskommandon
| Group | Beskrivning och kommandon |
|---|---|
| dashboards | Kommandon för att ändra äldre instrumentpaneler:create, delete, get, list, , , restoreupdate |
| genie | Kommandon för att ändra Genie, vilket ger en kodfri upplevelse för företagsanvändare som drivs av AI/BI:create-message, execute-message-attachment-query, get-message, get-message-attachment-query-result, , , get-spacedstart-conversation |
| Lakeview | Kommandon som tillhandahåller specifika hanteringsåtgärder för AI/BI-instrumentpaneler:create, create-schedule, create-subscription, delete-schedule, delete-subscription, get, get-published, get-schedule, get-subscription, list, , list-schedules, list-subscriptions, migrate, publish, trash, , unpublish, updateupdate-schedule |
Marketplace-kommandon
| Group | Beskrivning och kommandon |
|---|---|
| konsumentuppfyllelser | Kommandon för att hantera uppfyllanden, som är entiteter som gör det möjligt för konsumenter att förhandsgranska installationer.get, list |
| konsumentinstallationer | Kommandon för att hantera installationer, som är entiteter som gör det möjligt för konsumenter att interagera med Databricks Marketplace-listor.create, delete, list, , , list-listing-installationsupdate |
| konsumentlistor | Kommandon för att hantera Databricks Marketplace-konsumentlistor:batch-get, get, , listsearch |
| consumer-personalization-requests | Kommandon för att hantera anpassningsbegäranden som gör det möjligt för kunder att interagera med det individualiserade marketplace-listflödet.create, , getlist |
| konsumentleverantörer | Kommandon för att hantera leverantörer, som är de entiteter som publicerar listor på Marketplace.batch-get, , getlist |
| provider-exchange-filters | Kommandon för att hantera Marketplace-utbytesfilter, som kurerar vilka grupper som kan komma åt ett utbyte.create, delete, , listupdate |
| leverantörsutbyten | Kommandon för att hantera Marketplace-utbyten, vilket gör det möjligt för leverantörer att dela sina listor med en kuraterad uppsättning kunder.add-listing-to-exchange, create, delete, delete-listing-from-exchange, get, list, , list-exchanges-for-listing, , list-listings-for-exchangeupdate |
| provider-files | Kommandon för att hantera Marketplace-filer, till exempel förhandsgranskningsanteckningsböcker och providerikoner.create, delete, , getlist |
| provider-listningar | Kommandon för att hantera providerlistor:create, delete, get, , , listupdate |
| provider-personalization-requests | Kommandon för att hantera anpassningsbegäranden, som är ett alternativ till omedelbart tillgängliga listor.list, update |
| provider-provider-analytics-dashboards | Kommandon för att hantera mallanalysen för leverantörer:create, get, , get-latest-versionupdate |
| provider-providers | Kommandon för att hantera leverantörer som hanterar tillgångar på Marketplace.create, delete, get, , , listupdate |
Appkommandon
| Group | Beskrivning och kommandon |
|---|---|
| apps | Kommandon för att hantera Databricks-appar, som körs direkt på din Databricks-instans, integrera med dina data, använda och utöka Databricks-tjänster och göra det möjligt för användare att interagera via enkel inloggning.create, delete, deploy, get, get-deployment, list, , list-deployments, run-local, start, , , stopupdate |
Kommandon för att rensa rum
| Group | Beskrivning och kommandon |
|---|---|
| clean-room-assets | Kommandon för att hantera rena rumstillgångar, som är data- och kodobjekt som tabeller, volymer och notebook-filer som delas med det rena rummet.create, delete, get, , , listupdate |
| clean-room-task-runs | Kommandon för att hantera uppgiftskörningar i rent rum, vilket är anteckningsbokskörningar i en renrumsmiljö.list |
| rena rum | Kommandon för att hantera rena rum. I rena rum används deltadelning och serverlös beräkning för att tillhandahålla en säker och sekretessskyddande miljö där flera parter kan arbeta tillsammans med känsliga företagsdata utan direkt åtkomst till varandras data.create, create-output-catalog, delete, get, , , listupdate |
Databaskommandon
| Group | Beskrivning och kommandon |
|---|---|
| databas | Kommandon för att hantera Lakebase-databasinstanser.create-database-catalog, create-database-instance, create-database-table, create-synced-database-table, delete-database-catalog, delete-database-instance, delete-database-table, delete-synced-database-table, find-database-instance-by-uid, , generate-database-credential, get-database-catalog, get-database-instance, get-database-table, get-synced-database-table, , list-database-instancesupdate-database-instance |
Ytterligare kommandon
| Group | Beskrivning och kommandon |
|---|---|
| api | Kommandon för att göra begäranden till Databricks REST API:delete, get, head, patch, , , postput |
| completion | Kommandon för att generera skriptet för automatisk komplettering för det angivna gränssnittet:bash, fish, , powershellzsh |
| configure | Konfigurera Databricks CLI. |
help |
Utdatasammanfattningsinformation för alla Databricks CLI-kommandon. |
| labs | Kommandon för att hantera Databricks Labs-installationer:clear-cache, install, installed, list, show, , , uninstallupgrade |
| version | Hämta den version av CLI som används för närvarande. |
Globala flaggor
Följande flaggor är tillgängliga för alla Databricks CLI-kommandon. Observera att vissa flaggor inte gäller för vissa kommandon. Detaljerad information om specifika kommandon och deras flaggor finns i kommandoradshjälpen.
--debug
Om felsökningsloggning ska aktiveras.
-h eller --help
Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.
--log-file sträng
En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.
--log-format format
Loggformattypen, text eller json. Standardvärdet är text.
--log-level sträng
En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.
-o, --output typ
Kommandots utdatatyp, text eller json. Standardvärdet är text.
-p, --profile sträng
Namnet på profilen i ~/.databrickscfg-filen som ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.
--progress-format format
Formatet för att visa förloppsloggar: default, append, inplaceeller json
-t, --target sträng
Om tillämpligt, paketmålet som ska användas