Comandi della interfaccia della riga di comando di Databricks

Nota

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso dell'interfaccia della riga di comando di Databricks è soggetto all'Informativa sulla privacy di Databricks e databricks, incluse eventuali disposizioni sui dati di utilizzo.

Questo articolo fornisce informazioni sui comandi dell'interfaccia della riga di comando di Databricks disponibili. Queste informazioni integrano la Guida della riga di comando. Per ulteriori informazioni sull'installazione e sull'uso della CLI di Databricks, consultare Installare o update la CLI di Databricks e Che cos'è la CLI di Databricks?.

L'interfaccia della riga di comando di Databricks include i gruppi di comandi elencati nei tablesseguenti. I gruppi di comandi contengono insiemi di comandi correlati, che possono anche contenere sottocomandi. Per visualizzare le informazioni sull'uso e la sintassi di un gruppo di comandi, di un singolo comando o di un sottocomando:

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

Molti comandi dell'interfaccia della riga di comando eseguono il mapping alle operazioni documentate nelle informazioni di riferimento sull'API REST di Azure Databricks.

Comandi dell'area di lavoro

Raggruppa	Descrizione e comandi
fs	Comandi per la gestione dei file e del file system: cat, cp, ls, mkdirrm
git-credentials	Comandi per la registrazione di token di accesso personali affinché Databricks esegua operazioni per conto dell'utente: create, delete, get, listupdate
repos	Comandi per consentire agli utenti di gestire i repository Git: create, delete, get, listupdate get-permission-levels, get-permissions, set-permissionsupdate-permissions
secrets	Comandi per la gestione di segreti, ambiti segreti e autorizzazioni di accesso: create-scope, delete-acl, , delete-scope, delete-secretget-acl, get-secretlist-aclslist-scopes, list-secretsput-aclput-secret
workspace	Comandi per list, importare, esportare ed eliminare notebook e cartelle nell'area di lavoro: delete, export, export-dir, get-statusimport, import-dir, , listmkdirs get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi di calcolo

Raggruppa	Descrizione e comandi
cluster-policies	Comandi per controllare la capacità degli utenti di configurare i cluster in base a un set di regole: create, delete, edit, getlist get-permission-levels, get-permissions, set-permissionsupdate-permissions
clusters	Comandi che consentono di creare, avviare, modificare, list, terminare ed eliminare cluster: change-owner, create, , delete, editeventsgetlistlist-node-typeslist-zonespermanent-deletepinresizerestartspark-versionsstartunpin get-permission-levels, get-permissions, set-permissionsupdate-permissions
global-init-scripts	Comandi che consentono agli amministratori dell'area di lavoro di configurare gli script di inizializzazione globali per l'area di lavoro: create, delete, get, listupdate
instance-pools	Comandi per creare, modificare, eliminare e list pool di istanze usando istanze cloud pronte all'uso, riducendo i tempi di avvio e ridimensionamento automatico di un cluster: create, delete, edit, getlist get-permission-levels, get-permissions, set-permissionsupdate-permissions
instance-profiles	Comandi per consentire agli amministratori di aggiungere i profili di istanza liste remove con cui gli utenti possono avviare cluster: add, edit, listremove
libraries	Comandi per installare, disinstallare e get lo stato delle librerie in un cluster: all-cluster-statuses, cluster-status, installuninstall
policy-families	Comandi per visualizzare le famiglie di criteri disponibili: get, list

Comandi per i processi

Raggruppa	Descrizione e comandi
jobs	Comandi per la gestione dei processi: cancel-all-runs, , , , , cancel-runcreatedeletedelete-runexport-rungetget-runget-run-outputlistlist-runsrepair-runresetrun-nowsubmitupdate get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi delta live Tables

Raggruppa	Descrizione e comandi
pipelines	Comandi per creare, modificare, eliminare, avviare e visualizzare i dettagli sulle pipeline: create delete, get, , get-update, list-pipeline-eventslist-pipelines, list-updates, start-update, , stopupdate get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi di Machine Learning

Raggruppa	Descrizione e comandi
experiments	Comandi per interagire con esperimenti, che sono l'unità principale dell'organizzazione in MLflow; tutte le esecuzioni MLflow appartengono a un esperimento: create-experiment, create-run, delete-experiment, , delete-rundelete-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
model-registry	Comandi per il Registro modelli di area di lavoro: approve-transition-request, create-comment, create-model, create-model-version, create-transition-requestcreate-webhookdelete-commentdelete-modeldelete-model-tagdelete-model-versiondelete-model-version-tagdelete-transition-requestdelete-webhookget-latest-versionsget-modelget-model-versionget-model-version-download-uri, , list-modelslist-transition-requestslist-webhooksreject-transition-requestrename-modelsearch-model-versionssearch-modelsset-model-tagset-model-version-tagtest-registry-webhooktransition-stageupdate-commentupdate-modelupdate-model-versionupdate-webhook get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi di gestione in tempo reale

Raggruppa	Descrizione e comandi
serving-endpoints	Comandi per creare, updateed eliminare gli endpoint di gestione del modello: build-logs, create, , delete, export-metricsget, listlogspatch, putqueryupdate-config get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi per la gestione di identità e accessi

Raggruppa	Descrizione e comandi
account	Comandi per la gestione degli account Databricks: - Identità e accesso: access-control, groups, service-principals, users, workspace-assignment - Unity Catalog: metastore-assignments, metastores, storage-credentials - Impostazioni: ip-access-lists, network-connectivity, settings - Provisioning: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces - Fatturazione: billable-usage, log-delivery - OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
aut	Comandi per l'autenticazione: describe, env, login, profilestoken
current-user	Comandi per recuperare informazioni sull'utente o l'entità servizio attualmente autenticati: me
groups	Comandi per i gruppi che semplificano la gestione delle identità, rendendo più facile l'assegnazione dell'accesso all'area di lavoro di Databricks, ai dati e ad altri oggetti a protezione diretta: create, delete, get, list, patchupdate
permissions	Comandi per creare, leggere, scrivere, modificare e gestire l'accesso (update) per vari utenti a oggetti ed endpoint diversi. get, set, update get-permission-levels
service-principals	Comandi per le identità da utilizzare con lavori, strumenti automatici e sistemi come script, app e piattaforme CI/CD: create, delete, get, list, patchupdate
users	Comandi per le identità utente riconosciute da Databricks e rappresentate da indirizzi e-mail: create, delete, get, list, patchupdate get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi relativi a SQL

Raggruppa	Descrizione e comandi
alerts	Comandi per eseguire operazioni sugli avvisi: create, delete, get, listupdate
data-sources	Comandi per creare nuovi oggetti query: list
queries	Comandi per eseguire operazioni sulle definizioni di query: create, delete, get, list, restoreupdate
query-history	Comandi per accedere alla cronologia delle query tramite SQL warehouse: list
warehouses	Comandi per gestire i warehouse SQL, che sono una risorsa di calcolo che consente di eseguire comandi SQL su oggetti di dati all'interno di Databricks SQL: create, delete, edit, get, get-workspace-warehouse-configlist, set-workspace-warehouse-config, , startstop get-permission-levels, get-permissions, set-permissionsupdate-permissions

Unity Catalog comandi

Raggruppa	Descrizione e comandi
artifact-allowlists	Comandi per gestire gli elenchi di elementi consentiti. In Databricks Runtime 13.3 e versioni successive, è possibile aggiungere librerie e script di init all'elenco dei permessi in UC, in modo che gli utenti possano utilizzare questi artefatti su computer configurati con modalità di accesso condivisa: get, update
catalogs	Comandi per gestire catalogs, il primo livello dello spazio dei nomi a tre livelli di Unity Catalog: create, delete, get, listupdate
connections	Comandi per creare una connessione a un'origine dati esterna: create, delete, get, listupdate
external-locations	Comandi per la gestione delle posizioni esterne, che combinano un percorso di archiviazione nel cloud con una credenziale di archiviazione che autorizza l'accesso al percorso di archiviazione nel cloud: create, delete, get, listupdate
functions	Comandi per gestire funzioni User-Defined (UDF) in Unity Catalog: create, delete, get, listupdate
grants	Comandi per grant l'accesso ai dati in Unity Catalog: get, get-effective, update
metastores	Comandi per gestire metastores, ovvero il contenitore di primo livello di oggetti in Unity Catalog: assign create, current, , delete, getlist, summary, unassign, , updateupdate-assignment
model-versions	Comandi per gestire le versioni del modello. Databricks fornisce una versione ospitata di MLflow Model Registry in Unity Catalog. delete, get, get-by-alias, listupdate
online-tables	Comandi per gestire tablesonline, che offrono una latenza inferiore e un accesso QPS superiore ai dati da Delta tables: create, delete, get
quality-monitors	Comandi per gestire i monitoraggi, che calcolano e monitorano le metriche di qualità dei dati o del modello per un table nel tempo: create, delete, get, get-refreshlist-refreshes, , run-refreshupdate
registered-models	Comandi per gestire i modelli registrati. Databricks fornisce una versione ospitata di MLflow Model Registry in Unity Catalog. create, delete, delete-alias, getlist, , set-aliasupdate
schemas	Comandi per gestire gli schemi, che sono il secondo livello del namespace a tre livelli di Unity Catalog: create, delete, get, listupdate
storage-credentials	Comandi per gestire l'archiviazione credentials, che sono un meccanismo di autenticazione e autorizzazione per l'accesso ai dati archiviati nel tenant cloud: create, delete, get, list, updatevalidate
system-schemas	Comandi per gestire gli schemi di sistema, ovvero schemi che si trovano all'interno del sistema catalog: disable, enable, list
table-constraints	Comandi per gestire la chiave primaria e i vincoli di chiave esterna che codificano le relazioni tra i campi in tables: create, delete
tables	Comandi per gestire tables, che risiede nel terzo livello nello spazio dei nomi a tre livelli di Unity Catalog. delete, exists, get, listlist-summaries
volumes	Comandi per gestire volumes, che sono una funzionalità Catalog (UC) di Unity per l'accesso, l'archiviazione, la gestione, l'organizzazione e l'elaborazione dei file: create, delete, list, readupdate
workspace-bindings	Comandi per gestire le associazioni di aree di lavoro a protezione diretta. Le entità a protezione diretta in Databricks possono essere configurate come OPEN o ISOLATED. get, get-bindings, updateupdate-bindings

Comandi di condivisione Delta

Raggruppa	Descrizione e comandi
providers	Comandi per gestire i dati providers, che rappresentano le organizzazioni che condividono i dati: create, delete, get, list, list-sharesupdate
recipient-activation	Comandi per gestire l'attivazione del destinatario, applicabile solo nel modello di condivisione aperta where l'oggetto destinatario ha il tipo di autenticazione TOKEN: get-activation-url-info, retrieve-token
recipients	Comandi per gestire recipients, creati usando :method:recipients/create per rappresentare un'organizzazione a cui si vuole consentire l'accesso a shares: create, delete, get, list, rotate-tokenupdate share-permissions
shares	Comandi per gestire shares, che sono contenitori istanziati con :method:shares/create: create, delete, get, listupdate share-permissions, update-permissions

Comandi Impostazioni

Raggruppa	Descrizione e comandi
ip-access-lists	Comandi per consentire agli amministratori di configurare gli elenchi di accesso IP: create, delete, get, list, replaceupdate
settings	Comandi per consentire agli utenti di gestire le impostazioni a livello di area di lavoro: automatic-cluster-update, csp-enablement, default-namespace, esm-enablementrestrict-workspace-admins
token-management	Comandi che consentono agli amministratori di get tutti i token ed eliminare i token per altri utenti: create-obo-token, delete, getlist get-permission-levels, get-permissions, set-permissionsupdate-permissions
tokens	Comandi per creare, liste revoke token che possono essere usati per autenticare e accedere alle API REST di Databricks: create, delete, list
workspace-conf	Ai comandi delle impostazioni dell'area di lavoro update: get-status, set-status

Comandi Strumenti di sviluppo

Raggruppa	Descrizione e comandi
bundle	Comandi per gestire i bundle di risorse di Databricks, che consentono di esprimere i progetti di Databricks come codice: deploy, deployment, , destroy, generateinit, openrunschema, summarysyncvalidate
sync	Sincronizzare una directory locale in una directory dell'area di lavoro.

Comandi di ricerca vettoriale

Raggruppa	Descrizione e comandi
vector-search-endpoints	Comandi per gestire gli endpoint di ricerca vettoriale, che rappresentano le risorse di calcolo per gli indici di ricerca vettoriale host: create-endpoint, delete-endpoint, get-endpointlist-endpoints
vector-search-indexes	Comandi per gestire gli indici di ricerca vettoriale, una rappresentazione efficiente dei vettori di incorporamento che supporta query di ricerca approssimativa dei vicini (ANN) efficienti e in tempo reale: create-index, delete-data-vector-index, delete-index, get-indexlist-indexes, query-index, , sync-indexupsert-data-vector-index

Comandi Dashboard

Raggruppa	Descrizione e comandi
dashboards	Comandi per la modifica dei dashboard: create, delete, get, list, restoreupdate
lakeview	Comandi che forniscono operazioni di gestione specifiche per i dashboard di IA/BI: create, get, get-published, migratepublish, trash, , unpublishupdate

Comandi aggiuntivi

Raggruppa	Descrizione e comandi
api	Comandi per effettuare richieste all'API REST di Databricks: delete, get, head, patch, postput
completion	Comandi per generate lo script di completamento automatico per la shell specificata: bash, fish, powershellzsh
configure	Configurare l'interfaccia della riga di comando di Databricks.
help	Restituisce informazioni sull'utilizzo per qualsiasi comando.
labs	Comandi per gestire le installazioni di Databricks Labs: clear-cache, install, installed, listshow, , uninstallupgrade
version	Recuperare la versione dell'interfaccia della riga di comando attualmente in uso.

Flag globali

I seguenti flag sono disponibili per tutti i comandi dell'interfaccia della riga di comando di Databricks. Si noti che alcuni flag non si applicano ad alcuni comandi. Per informazioni dettagliate su comandi specifici e sui relativi flag, vedere la Guida della riga di comando.

Flag	Descrizione
-h oppure --help	Visualizzare la Guida per l'interfaccia della riga di comando di Databricks o il gruppo di comandi correlato o il comando correlato.
-e oppure --environment string	Stringa che rappresenta l'ambiente bundle da usare se applicabile per il comando correlato.
--log-file	Stringa che rappresenta l'oggetto in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.
--log-format	text per scrivere i log di output in testo o json per scrivere i log di output in JSON. Se questo flag non viene specificato, i log di output vengono scritti come testo.
--log-level	Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.
-o oppure --output	text per scrivere l’output in testo o json per scrivere l’output in JSON. Se questo flag non viene specificato, l'output viene scritto come testo.
-p oppure --profile	Stringa che rappresenta il profilo di configurazione denominato da usare all'interno del file .databrickscfg. Se questo flag non viene specificato, viene utilizzato il profilo denominato DEFAULT, se esiste. È possibile premere Tab dopo --profile o -p per visualizzare un list di profili di configurazione disponibili esistenti tra cui scegliere anziché immettere manualmente il nome del profilo di configurazione.
--progress-format	Formato per i log di stato da visualizzare (default (impostazione predefinita) o append o inplace o json).