Condividi tramite

Comandi della interfaccia della riga di comando di Databricks

  • Articolo

Nota

Queste informazioni si applicano alle versioni del Databricks CLI 0.205 e superiori, disponibili in Anteprima Pubblica. Per trovare la versione del Databricks CLI, eseguire databricks -v.

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 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 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, mkdir, rm
git-credentials Comandi per la registrazione di token di accesso personali affinché Databricks esegua operazioni per conto dell'utente:

create, delete, get, list, update
repos Comandi per consentire agli utenti di gestire i repository Git:

create, delete, get, list, update

get-permission-levels, get-permissions, set-permissions, update-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-status, import, import-dir, list, mkdirs

get-permission-levels, get-permissions, set-permissions, update-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, get, list

get-permission-levels, get-permissions, set-permissions, update-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-permissions, update-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, list, update
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, get, list

get-permission-levels, get-permissions, set-permissions, update-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, list, remove
libraries Comandi per installare, disinstallare e ottenere lo stato delle librerie in un cluster:

all-cluster-statuses, cluster-status, install, uninstall
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-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

Comandi per le tabelle Delta Live

Raggruppa 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-permissions, update-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-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-permissions, update-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-permissions, update-permissions

Comandi di gestione in tempo reale

Raggruppa 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-permissions, update-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, profiles, token
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, patch, update
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, patch, update
users Comandi per le identità utente riconosciute da Databricks e rappresentate da indirizzi e-mail:

create, delete, get, list, patch, update

get-permission-levels, get-permissions, set-permissions, update-permissions
Raggruppa Descrizione e comandi
alerts Comandi per eseguire operazioni sugli avvisi:

create, delete, get, list, update
data-sources Comandi per creare nuovi oggetti query:

list
queries Comandi per eseguire operazioni sulle definizioni di query:

create, delete, get, list, restore, update
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-config, list, set-workspace-warehouse-config, start, stop

get-permission-levels, get-permissions, set-permissions, update-permissions

Comandi di Unity Catalog

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 i cataloghi, il primo livello dello spazio dei nomi a tre livelli di Unity Catalog:

create, delete, get, list, update
connections Comandi per creare una connessione a un'origine dati esterna:

create, delete, get, list, update
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, list, update
functions Comandi per gestire funzioni definite dall'utente (UDF) in Unity Catalog:

create, delete, get, list, update
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 catalogo unity.

delete, get, get-by-alias, list, update
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-refresh, list-refreshes, run-refresh, update
registered-models Comandi per gestire i modelli registrati. Databricks offre una versione ospitata di MLflow Model Registry nel catalogo unity.

create, delete, delete-alias, get, list, set-alias, update
schemas Comandi per gestire gli schemi, ovvero il secondo livello dello spazio dei nomi a tre livelli di Unity Catalog:

create, delete, get, list, update
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, update, validate
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, list, list-summaries
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, read, update
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, update, update-bindings

Comandi di condivisione Delta

Raggruppa Descrizione e comandi
providers Comandi per gestire i provider di dati, che rappresentano le organizzazioni che condividono i dati:

create, delete, get, list, list-shares, update
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-token, update

share-permissions
shares Comandi per gestire le condivisioni, che sono contenitori di cui è stata creata un'istanza con :method:shares/create:

create, delete, get, list, update

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, replace, update
settings Comandi per consentire agli utenti di gestire le impostazioni a livello di area di lavoro:

automatic-cluster-update, csp-enablement, default-namespace, esm-enablement, restrict-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, get, list

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

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, generate, init, run, schema, sync, validate
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-endpoint, list-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-index, list-indexes, query-index, sync-index, upsert-data-vector-index

Comandi Dashboard

Raggruppa Descrizione e comandi
dashboards Comandi per la modifica dei dashboard:

create, delete, get, list, restore, update
lakeview Comandi che forniscono operazioni di gestione specifiche per i dashboard di IA/BI:

create, get, get-published, migrate, publish, trash, unpublish, update

Comandi aggiuntivi

Raggruppa Descrizione e comandi
api Comandi per effettuare richieste all'API REST di Databricks:

delete, get, head, patch, post, put
completion Comandi per generare lo script di completamento automatico per una shell specificata:

bash, fish, powershell, zsh
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, list, show, uninstall, upgrade
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 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).