Databricks CLI-kommandon

  • Artikel

Kommentar

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> -h
  • databricks <command-group> <command-name> -h
  • databricks <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

Grupp Beskrivning och kommandon
Fs Kommandon för att hantera filer och filsystemet:

cat, cp, ls, , , mkdirrm
git-credentials 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, , , listupdate

get-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, , listmkdirs

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Beräkningskommandon

Grupp Beskrivning och kommandon
cluster-policies Kommandon för att styra användarnas möjlighet att konfigurera kluster baserat på en uppsättning regler:

create, delete, edit, , , getlist

get-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, , startunpin

get-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
instance-pools 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, , , getlist

get-permission-levels, get-permissions, , set-permissionsupdate-permissions
instance-profiles 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
libraries 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

Grupp 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, , submitupdate

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Delta Live Tables-kommandon

Grupp 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, , stopupdate

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Machine Learning-kommandon

Grupp 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, set-experiment-tagsearch-runs, set-tag, update-experimentupdate-run

get-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-versionget-model, ,get-model-version-download-uri, list-transition-requestslist-modelslist-webhooksreject-transition-request, rename-modelsearch-model-versions, , set-model-version-tagset-model-tagsearch-models, , test-registry-webhook, transition-stage, update-comment, update-model, , , update-model-versionupdate-webhook

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Kommandon för realtidsservering

Grupp Beskrivning och kommandon
serving-endpoints 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-config

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Identitets- och åtkomsthanteringskommandon

Grupp Beskrivning och kommandon
account Kommandon för att hantera Databricks-konton:

- Identitet och åtkomst: access-control, groups, service-principals, , usersworkspace-assignment
- Unity Catalog: metastore-assignments, metastores, storage-credentials
- Inställningar: ip-access-lists, network-connectivity, settings
- Etablering: credentials, encryption-keys, networks, private-access, storage, , , vpc-endpointsworkspaces
- Fakturering: billable-usage, log-delivery
- OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
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, , setupdate

get-permission-levels
service-principals 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, , , patchupdate

get-permission-levels, get-permissions, , set-permissionsupdate-permissions
Grupp Beskrivning och kommandon
alerts Kommandon för att utföra åtgärder på aviseringar:

create, delete, get, , , listupdate
data-sources 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
query-history Kommandon för att komma åt historiken för frågor via SQL-lager:

list
warehouses 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, , startstop

get-permission-levels, get-permissions, , set-permissionsupdate-permissions

Unity Catalog-kommandon

Grupp 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 läget för delad åtkomst:

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
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
metastores 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
model-versions 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-tables Kommandon för att hantera onlinetabeller, vilket ger kortare svarstid och högre QPS-åtkomst till data från Delta-tabeller:

create, , deleteget
quality-monitors 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
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
storage-credentials 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
system-schemas Kommandon för att hantera systemscheman, som är scheman som finns i systemkatalogen:

disable, , enablelist
table-constraints 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
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
workspace-bindings 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

Grupp Beskrivning och kommandon
providers Kommandon för att hantera dataprovidrar, som representerar de organisationer som delar data:

create, delete, get, list, , , list-sharesupdate
recipient-activation 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
recipients Kommandon för att hantera mottagare som du skapar med för :method:recipients/create att representera en organisation som du vill tillåta åtkomst till resurser:

create, delete, get, list, , , rotate-tokenupdate

share-permissions
shares Kommandon för att hantera resurser, som är containrar som instansieras med :method:shares/create:

create, delete, get, , , listupdate

share-permissions, update-permissions

Inställningskommandon

Grupp 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
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
token-management 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, , getlist

get-permission-levels, get-permissions, , set-permissionsupdate-permissions
tokens 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

Utvecklarverktyg kommandon

Grupp Beskrivning och kommandon
knyte 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, run, , schema, , syncvalidate
synkronisering Synkronisera en lokal katalog till en arbetsytekatalog.

Vektorsökningskommandon

Grupp 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öder realtids- och effektiv ungefärliga ann-sökfrågor (ANN):

create-index, delete-data-vector-index, delete-index, get-index, list-indexes, , query-index, , sync-indexupsert-data-vector-index

Instrumentpanelskommandon

Grupp Beskrivning och kommandon
dashboards Kommandon för att ändra instrumentpaneler:

create, delete, get, list, , , restoreupdate
lakeview Kommandon som tillhandahåller specifika hanteringsåtgärder för AI/BI-instrumentpaneler:

create, get, get-published, migrate, publish, , trash, , unpublishupdate

Ytterligare kommandon

Grupp Beskrivning och kommandon
api Kommandon för att göra begäranden till Databricks REST API:

delete, get, head, patch, , , postput
fullbordande Kommandon för att generera skriptet för automatisk komplettering för det angivna gränssnittet:

bash, fish, , powershellzsh
konfigurera Konfigurera Databricks CLI.
help Utdataanvändningsinformation för alla 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.

Flagga beskrivning
-h eller --help Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.
-e eller --environment string En sträng som representerar paketmiljön som ska användas om tillämpligt för det relaterade kommandot.
--log-file En sträng som representerar att skriva utdataloggar till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.
--log-format text om du vill skriva utdataloggar till text eller json skriva utdataloggar till JSON. Om den här flaggan inte anges skrivs utdataloggarna som text.
--log-level En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.
-o eller --output text för att skriva utdata som text eller json skriva utdata som JSON. Om den här flaggan inte anges skrivs utdata som text.
-p eller --profile En sträng som representerar den namngivna konfigurationsprofilen som ska användas i .databrickscfg filen. Om den här flaggan inte anges används den DEFAULT namngivna profilen om den finns. Du kan trycka Tab efter --profile eller -p visa en lista över befintliga tillgängliga konfigurationsprofiler att välja mellan i stället för att ange namnet på konfigurationsprofilen manuellt.
--progress-format Formatet för förloppsloggar som ska visas (default (standard) eller append eller inplace ).json