Condividi tramite


Comandi di Databricks CLI

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 alla Licenza Databricks e all'Informativa sulla privacy di 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 l'assistenza della riga di comando. Per altre informazioni sull'installazione e l'uso dell'interfaccia della riga di comando di Databricks, vedere Installare o aggiornare l'interfaccia della riga di comando di Databricks e Informazioni sull'interfaccia della riga di comando di Databricks.

L'interfaccia della riga di comando di Databricks include i gruppi di comandi elencati nelle seguenti tabelle. 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 si collegano alle operazioni documentate nella documentazione di riferimento dell'API REST di Azure Databricks.

Comandi dell'area di lavoro

Gruppo 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-secret, get-acl, get-secret, list-acls, list-scopes, list-secrets, put-acl, put-secret
workspace Comandi per elencare, 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

Gruppo 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, elencare, terminare ed eliminare cluster:
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 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 ed elencare i pool di istanze usando istanze cloud pronte per l'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, elencare e rimuovere profili di istanza con cui gli utenti possono avviare cluster con:
add, edit, listremove
libraries Comandi per installare, disinstallare e ottenere 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

Gruppo Descrizione e comandi
jobs Comandi per la gestione dei processi:
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

Comandi DLT

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

Comandi di Machine Learning

Gruppo 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-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 Comandi per il Registro modelli di area di lavoro:
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

Comandi di gestione in tempo reale

Gruppo Descrizione e comandi
serving-endpoints Comandi per creare, aggiornare ed eliminare gli endpoint di gestione del modello:
build-logs, create, delete, export-metrics, get, list, logs, patch, put, query, update-config
get-permission-levels, get-permissions, set-permissionsupdate-permissions

Comandi per la gestione di identità e accessi

Gruppo Descrizione e comandi
account Comandi per la gestione degli account Databricks:
  • Identità e accesso: access-control, groups, service-principals, users, workspace-assignment
  • Catalogo Unity: metastore-assignments, metastores, storage-credentials
  • Impostazioni: ip-access-lists, network-connectivity, settings
  • Approvvigionamento: 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
autenticazione 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 l'accesso in lettura, scrittura, modifica, aggiornamento e gestione per vari utenti su 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
Gruppo Descrizione e comandi
alerts Comandi per eseguire operazioni sugli avvisi:
create, delete, get, listupdate
alerts-legacy Comandi per eseguire operazioni sugli avvisi legacy:
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
queries-legacy Comandi per eseguire operazioni sulle definizioni di query legacy:
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

Comandi di Unity Catalog

Gruppo 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 init all'elenco elementi consentiti in UC in modo che gli utenti possano sfruttare questi artefatti nel calcolo configurato con la modalità di accesso standard:
get, update
catalogs Comandi per gestire i cataloghi, il primo livello dello spazio dei nomi a tre livelli di Unity Catalog:
create, delete, get, listupdate
credentials Comandi per gestire le credenziali, ovvero il meccanismo di autenticazione e autorizzazione per l'accesso ai servizi nel tenant cloud. Ogni credenziale è soggetta ai criteri di controllo di accesso del catalogo Unity che controllano quali utenti e gruppi possono accedere alle credenziali.
create-credential, delete-credential, generate-temporary-service-credential, get-credentiallist-credentials, , update-credentialvalidate-credential
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 definite dall'utente (UDF) nel catalogo Unity:
create, delete, get, listupdate
grants Comandi per concedere l'accesso ai dati in Unity Catalog:
get, get-effective, update
metastores Comandi per gestire i metastore, ovvero il contenitore di primo livello degli oggetti in Unity Catalog:
assign, create, current, delete, get, list, summary, unassign, update, update-assignment
model-versions Comandi per gestire le versioni del modello. Databricks offre una versione ospitata di MLflow Model Registry nel Unity Catalog.
delete, get, get-by-alias, listupdate
online-tables Comandi per gestire le tabelle online, che offrono una latenza inferiore e un accesso QPS superiore ai dati dalle tabelle Delta:
create, delete, get
quality-monitors Comandi per gestire i monitoraggi, che calcolano e monitorano le metriche di qualità dei dati o del modello per una tabella nel tempo:
create, delete, get, get-refreshlist-refreshes, , run-refreshupdate
registered-models Comandi per gestire i modelli registrati. Databricks offre una versione ospitata di MLflow Model Registry nel Unity Catalog.
create, delete, delete-alias, getlist, , set-aliasupdate
resource-quotas Comandi per gestire le quote di risorse applicate dal catalogo Unity su tutti gli oggetti a protezione diretta, che limitano il numero di risorse che è possibile creare.
get-quota, list-quotas
schemas Comandi per gestire gli schemi, ovvero il secondo livello dello spazio dei nomi a tre livelli di Unity Catalog:
create, delete, get, listupdate
storage-credentials Comandi per gestire le credenziali di archiviazione, 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 catalogo di sistema:
disable, enable, list
table-constraints Comandi per gestire i vincoli di chiave primaria e di chiave esterna che codificano le relazioni tra i campi nelle tabelle:
create, delete
tables Comandi per gestire le tabelle, che si trovano nel terzo livello dello spazio dei nomi a tre livelli di Unity Catalog:
delete, exists, get, listlist-summaries
temporary-table-credentials Comandi per gestire le credenziali temporanee delle tabelle, cioè credenziali di breve durata con privilegi ridotti, utilizzate per accedere alle posizioni di archiviazione cloud dove i dati delle tabelle sono conservati in Databricks.
generate-temporary-table-credentials
volumes Comandi per gestire i volumi, che sono una funzionalità di Unity Catalog (UC) per l'accesso, l'archiviazione, la gestione, l'organizzazione e l'elaborazione dei file:
create, delete, list, readupdate
workspace-bindings Comandi per gestire i collegamenti sicuri dell'area di lavoro. Gli elementi di sicurezza in Databricks possono essere configurati come OPEN o ISOLATED.
get, get-bindings, updateupdate-bindings

Comandi di condivisione Delta

Gruppo Descrizione e comandi
providers Comandi per gestire i provider di dati, 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 aperto in cui l'oggetto destinatario ha l'autenticazione di tipo con TOKEN:
get-activation-url-info, retrieve-token
recipients Comandi per la gestione dei destinatari, creati con :method:recipients/create per rappresentare un'organizzazione a cui si vuole consentire l'accesso alle condivisioni:
create, delete, get, list, rotate-tokenupdate
share-permissions
shares Comandi per gestire le condivisioni, che sono contenitori istanziati con :method:shares/create:
create, delete, get, listupdate
share-permissions, update-permissions

Comandi delle Impostazioni

Gruppo Descrizione e comandi
ip-access-lists Comandi per consentire agli amministratori di configurare gli elenchi di accesso IP:
create, delete, get, list, replaceupdate
notification-destinations Comandi per gestire le destinazioni di notifica di un'area di lavoro:
create, delete, get, listupdate
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 per consentire agli amministratori di ottenere tutti i token e di eliminare i token di altri utenti:
create-obo-token, delete, getlist
get-permission-levels, get-permissions, set-permissionsupdate-permissions
tokens Comandi per creare, elencare e revocare i token che possono essere usati per autenticare e accedere alle API REST di Databricks:
create, delete, list
workspace-conf Comandi per aggiornare le impostazioni dell'area di lavoro:
get-status, set-status

I comandi degli strumenti di sviluppo

Gruppo Descrizione e comandi
pacchetto Comandi per gestire i bundle di risorse di Databricks, che consentono di esprimere i progetti di Databricks come codice:
deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate
Sincronizzazione Sincronizzare una directory locale con una directory dell'area di lavoro.

Comandi di ricerca vettoriale

Gruppo 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 efficienti e in tempo reale dell'ANN (approssimativa dei vicini più prossimi):
create-index, delete-data-vector-index, delete-index, get-indexlist-indexes, query-index, , sync-indexupsert-data-vector-index

Comandi del Dashboard

Gruppo Descrizione e comandi
dashboards Comandi per la modifica dei dashboard legacy:
create, delete, get, list, restoreupdate
genie Comandi per la modifica di Genie, che offre un'esperienza senza codice per gli utenti aziendali, basata su intelligenza artificiale/BI:
create-message, execute-message-attachment-query, get-message, get-message-attachment-query-result, get-spacedstart-conversation
lakeview Comandi che forniscono operazioni di gestione specifiche per i dashboard di IA/BI:
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, update, update-schedule

Comandi del Marketplace

Gruppo Descrizione e comandi
consumer-fulfillments Comandi per la gestione degli adempimenti, ovvero entità che consentono ai consumer di visualizzare in anteprima le installazioni.
get, list
consumer-installations Comandi per la gestione delle installazioni, ovvero entità che consentono agli utenti di interagire con le presentazioni di Databricks Marketplace.
create, delete, list, list-listing-installationsupdate
consumer-listings Comandi per la gestione degli annunci di Databricks Marketplace per i consumatori:
batch-get, get, listsearch
consumer-personalization-requests Comandi per la gestione delle richieste di personalizzazione, che consentono ai clienti di interagire con il flusso di presentazione del Marketplace personalizzato.
create, get, list
consumer-providers Comandi per la gestione dei provider, ovvero le entità che pubblicano presentazioni nel Marketplace.
batch-get, get, list
provider-exchange-filters Comandi per la gestione dei filtri di scambio del Marketplace, che curano quali gruppi possono accedere a uno scambio.
create, delete, listupdate
provider-exchanges Comandi per la gestione degli scambi del Marketplace, che consentono ai provider di condividere le inserzioni con un set curato di clienti.
add-listing-to-exchange, create, delete, delete-listing-from-exchange, getlist, list-exchanges-for-listing, , list-listings-for-exchangeupdate
provider-files Comandi per la gestione dei file del Marketplace, come i notebook di anteprima e le icone del provider.
create, delete, getlist
provider-listings Comandi per la gestione delle liste dei provider:
create, delete, get, listupdate
provider-personalization-requests Comandi per gestire le richieste di personalizzazione, che sono un'alternativa agli elenchi disponibili istantaneamente.
list, update
provider-provider-analytics-dashboards Comandi per gestire l'analisi modello per i provider:
create, get, get-latest-versionupdate
provider-providers Comandi per gestire i provider, che gestiscono gli asset in Marketplace.
create, delete, get, listupdate

Comandi delle app

Gruppo Descrizione e comandi
apps Comandi per gestire le app Databricks, che vengono eseguite direttamente nell'istanza di Databricks, si integrano con i dati, usano ed estendono i servizi Databricks e consentono agli utenti di interagire tramite Single Sign-On.
create, delete, deploy, get, get-deployment, list, list-deployments, run-local, start, stop, update

Comandi per camere sterili

Gruppo Descrizione e comandi
clean-room-assets Comandi per gestire gli asset della sala pulita, ovvero dati e oggetti di codice, ad esempio tabelle, volumi e notebook condivisi con la stanza pulita.
create, delete, get, listupdate
clean-room-task-runs Comandi per gestire le esecuzioni di attività della sala pulita, ovvero le esecuzioni di notebook in una stanza pulita.
list
clean-rooms Comandi per gestire le stanze pulite. Le stanze pulite usano la condivisione delta e il calcolo serverless per fornire un ambiente sicuro e protetto dalla privacy in cui più parti possono collaborare sui dati aziendali sensibili senza accesso diretto ai dati dell'altro.
create, create-output-catalog, delete, get, listupdate

Comandi aggiuntivi

Gruppo Descrizione e comandi
API Comandi per effettuare richieste all'API REST di Databricks:
delete, get, head, patch, postput
completamento Comandi per generare lo script di completamento automatico per una shell specificata:
bash, fish, powershellzsh
configurare Configurare il CLI di Databricks.
help Restituisce informazioni sull'utilizzo per qualsiasi comando.
Laboratori Comandi per gestire le installazioni di Databricks Labs:
clear-cache, install, installed, listshow, , uninstallupgrade
version Ottenere la versione della CLI attualmente in uso.

Bandiere globali

I seguenti flag sono disponibili per tutti i comandi dell'interfaccia della riga di comando di Databricks. Nota che alcuni flag non si applicano a certi comandi. Per informazioni dettagliate su comandi specifici e sui relativi flag, consultare la guida della riga di comando.

Bandiera Descrizione
-h oppure --help Mostra la guida per il Databricks CLI, 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 dove 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 elenco 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).