Delen via

Databricks CLI-opdrachten

  • Artikel

Notitie

Deze informatie is van toepassing op Databricks CLI-versies 0.205 en hoger. De Databricks CLI bevindt zich in openbare preview.

Databricks CLI-gebruik is onderhevig aan de Databricks-licentie en de privacyverklaring van Databricks, met inbegrip van alle bepalingen voor gebruiksgegevens.

Dit artikel bevat informatie over beschikbare Databricks CLI-opdrachten. Deze informatie vormt een aanvulling op de helpfunctie voor de opdrachtregel. Zie De Databricks CLI installeren of bijwerken en wat is de Databricks CLI? voor meer informatie over het installeren en gebruiken van de Databricks CLI.

De Databricks CLI bevat de opdrachtgroepen die worden vermeld in de volgende tabellen. Opdrachtgroepen bevatten sets met gerelateerde opdrachten, die ook subopdrachten kunnen bevatten. Gebruiks- en syntaxisgegevens voor een opdrachtgroep, een afzonderlijke opdracht of subopdracht uitvoeren:

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

Veel CLI-opdrachten komen overeen met bewerkingen die in de Azure Databricks REST API-referentie worden beschreven.

Werkruimteopdrachten

Groep Beschrijving en opdrachten
Fs Opdrachten voor het beheren van bestanden en het bestandssysteem:
cat cp, ls, mkdirrm
git-credentials Opdrachten voor het registreren van persoonlijke toegangstokens voor Databricks om bewerkingen uit te voeren namens de gebruiker:
create delete, get, listupdate
repos Opdrachten waarmee gebruikers hun Git-opslagplaatsen kunnen beheren:
create delete, get, listupdate
get-permission-levels, get-permissions, set-permissions, update-permissions
secrets Opdrachten voor het beheren van geheimen, geheime bereiken en toegangsmachtigingen:
create-scope, delete-acl, delete-scope, delete-secret, get-acl, get-secret, list-acls, list-scopes, list-secrets, put-acl, put-secret
workspace Opdrachten voor het weergeven, importeren, exporteren en verwijderen van notitieblokken en mappen in de werkruimte:
delete, , exportexport-dir, get-status, , import, , import-dirlistmkdirs
get-permission-levels, get-permissions, set-permissions, update-permissions

Berekeningsopdrachten

Groep Beschrijving en opdrachten
cluster-policies Opdrachten voor het beheren van de mogelijkheid van gebruikers om clusters te configureren op basis van een set regels:
create delete, edit, getlist
get-permission-levels, get-permissions, set-permissions, update-permissions
clusters Opdrachten waarmee u clusters kunt maken, starten, bewerken, weergeven, beëindigen en verwijderen:
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 Opdrachten waarmee werkruimtebeheerders globale initialisatiescripts voor hun werkruimte kunnen configureren:
create delete, get, listupdate
instance-pools Opdrachten voor het maken, bewerken, verwijderen en opnemen van instantie-pools met gebruiksklare cloudinstanties, wat de tijd voor het opstarten en automatisch schalen van een cluster verkort.
create delete, edit, getlist
get-permission-levels, get-permissions, set-permissions, update-permissions
instance-profiles Opdrachten waarmee beheerders exemplaarprofielen kunnen toevoegen, weergeven en verwijderen waarmee gebruikers clusters kunnen starten met:
add, edit, list, remove
libraries Opdrachten voor het installeren, verwijderen en ophalen van de status van bibliotheken in een cluster:
all-cluster-statuses, cluster-status, install, uninstall
policy-families Opdrachten voor het weergeven van beschikbare beleidsfamilies:
get, list

Opdrachten voor taken

Groep Beschrijving en opdrachten
jobs Opdrachten voor het beheren van taken:
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

DLT-opdrachten

Groep Beschrijving en opdrachten
pipelines Opdrachten voor het maken, bewerken, verwijderen, starten en weergeven van details over pijplijnen:
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

Machine Learning-opdrachten

Groep Beschrijving en opdrachten
experiments Opdrachten voor interactie met experimenten, die de primaire eenheid van de organisatie in MLflow zijn; alle MLflow-uitvoeringen horen bij een 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-runs, set-experiment-tag, set-tag, update-experiment, update-run
get-permission-levels, get-permissions, set-permissions, update-permissions
model-registry Opdrachten voor het werkruimtemodelregister:
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

Opdrachten in realtime leveren

Groep Beschrijving en opdrachten
serving-endpoints Opdrachten voor het maken, bijwerken en verwijderen van model voor eindpunten:
build-logs, create, delete, export-metrics, get, list, logs, patch, put, query, update-config
get-permission-levels, get-permissions, set-permissions, update-permissions

Opdrachten voor identiteits- en toegangsbeheer

Groep Beschrijving en opdrachten
account Opdrachten voor het beheren van Databricks-accounts:
  • Identiteit en toegang: access-control, groups, service-principals, users, workspace-assignment
  • Unity Catalog: metastore-assignments, metastores, storage-credentials
  • Instellingen: ip-access-lists, network-connectivity, settings
  • Inrichting: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces
  • Facturering: billable-usage, log-delivery
  • OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
Auth Opdrachten voor verificatie:
describe env, login, profilestoken
current-user Opdrachten voor het ophalen van informatie over momenteel geverifieerde gebruikers of service-principals:
me
groups Opdrachten voor groepen die identiteitsbeheer vereenvoudigen, waardoor het eenvoudiger is om toegang toe te wijzen aan databricks-werkruimte, gegevens en andere beveiligbare objecten:
create, delete, get, list, patch, update
permissions Opdrachten voor het maken van lees-, schrijf-, bewerkings-, update- en beheertoegang voor verschillende gebruikers op verschillende objecten en eindpunten:
get set update
get-permission-levels
service-principals Opdrachten voor identiteiten voor gebruik met taken, geautomatiseerde hulpprogramma's en systemen zoals scripts, apps en CI/CD-platforms:
create, delete, get, list, patch, update
users Opdrachten voor gebruikersidentiteiten die worden herkend door Databricks en vertegenwoordigd door e-mailadressen:
create, delete, get, list, patch, update
get-permission-levels, get-permissions, set-permissions, update-permissions
Groep Beschrijving en opdrachten
alerts Commando's voor het uitvoeren van bewerkingen op waarschuwingen:
create delete, get, listupdate
data-sources Opdrachten voor het maken van nieuwe queryobjecten:
list
queries Opdrachten voor het uitvoeren van bewerkingen voor querydefinities:
create, delete, get, list, restore, update
query-history Opdrachten voor toegang tot de geschiedenis van query's via SQL Warehouses:
list
warehouses Opdrachten voor het beheren van SQL-warehouses, een rekenresource waarmee u SQL-opdrachten kunt uitvoeren op gegevensobjecten in 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

Unity Catalog-opdrachten

Groep Beschrijving en opdrachten
artifact-allowlists Opdrachten voor het beheren van acceptatielijsten voor artefacten. In Databricks Runtime 13.3 en hoger kunt u bibliotheken en init-scripts toevoegen aan de acceptatielijst in UC, zodat gebruikers deze artefacten kunnen gebruiken voor berekening die is geconfigureerd met de standaardtoegangsmodus:
get, update
catalogs Opdrachten voor het beheren van catalogi, de eerste laag van de naamruimte op drie niveaus van Unity Catalog:
create delete, get, listupdate
connections Opdrachten voor het maken van een verbinding met een externe gegevensbron:
create delete, get, listupdate
external-locations Opdrachten voor het beheren van externe locaties, waarbij een cloudopslagpad wordt gecombineerd met een opslagreferentie waarmee toegang tot het cloudopslagpad wordt toegestaan:
create delete, get, listupdate
functions Opdrachten voor het beheren van door de gebruiker gedefinieerde functies (UDF's) in de Unity-catalogus:
create delete, get, listupdate
grants Opdrachten voor het verlenen van toegang tot gegevens in Unity Catalog:
get get-effective update
metastores Opdrachten voor het beheren van metastores, de container op het hoogste niveau van objecten in Unity Catalog:
assign, create, current, delete, get, list, summary, unassign, update, update-assignment
model-versions Opdrachten voor het beheren van modelversies. Databricks biedt een gehoste versie van MLflow Model Registry in Unity Catalog.
delete get, get-by-alias, listupdate
online-tables Opdrachten voor het beheren van onlinetabellen, die lagere latentie en hogere QPS-toegang bieden tot gegevens uit Delta-tabellen:
create delete get
quality-monitors Opdrachten voor het beheren van monitors die kwaliteitsmetriek van gegevens of modellen voor een tabel in de loop van de tijd berekenen en bewaken:
create, , deleteget, get-refresh, , list-refreshes, , run-refreshupdate
registered-models Opdrachten voor het beheren van geregistreerde modellen. Databricks biedt een gehoste versie van MLflow Model Registry in Unity Catalog.
create, , deletedelete-alias, get, , list, , set-aliasupdate
schemas Opdrachten voor het beheren van schema's, de tweede laag van de naamruimte op drie niveaus van Unity Catalog:
create delete, get, listupdate
storage-credentials Opdrachten voor het beheren van opslagreferenties, een verificatie- en autorisatiemechanisme voor toegang tot gegevens die zijn opgeslagen in uw cloudtenant:
create, delete, get, list, update, validate
system-schemas Opdrachten voor het beheren van systeemschema's, schema's die zich in de systeemcatalogus bevinden:
disable enable list
table-constraints Opdrachten voor het beheren van beperkingen voor primaire sleutels en refererende sleutels waarmee relaties tussen velden in tabellen worden gecodeerd:
create, delete
tables Opdrachten voor het beheren van tabellen, die zich in de derde laag van de naamruimte op drie niveaus van de Unity Catalog bevinden:
delete exists, get, listlist-summaries
volumes Opdrachten voor het beheren van volumes, die een UC-mogelijkheid (Unity Catalog) zijn voor het openen, opslaan, beheren, ordenen en verwerken van bestanden:
create delete, list, readupdate
workspace-bindings Opdrachten voor het beheren van beveiligbare werkruimtebindingen. Beveiligbare objecten in Databricks kunnen worden geconfigureerd als OPEN of ISOLATED.
get, get-bindings, update, update-bindings

Delta-deling opdrachten

Groep Beschrijving en opdrachten
providers Opdrachten voor het beheren van gegevensproviders, die de organisaties vertegenwoordigen die gegevens delen:
create, delete, get, list, list-shares, update
recipient-activation Commando's voor het beheren van activering van ontvangers, die alleen van toepassing zijn in het open sharingmodel waarbij het ontvangerobject het verificatietype TOKEN heeft:
get-activation-url-info, retrieve-token
recipients Opdrachten voor het beheren van geadresseerden, die u maakt met behulp van :method:recipients/create om een organisatie te vertegenwoordigen waaraan u toegang tot shares wilt verlenen.
create, delete, get, list, rotate-token, update
share-permissions
shares Opdrachten voor het beheren van gedeelde bestanden (shares), die containers zijn die zijn geïnstantieerd met :method:shares/create:
create delete, get, listupdate
share-permissions, update-permissions

Instellingenopdrachten

Groep Beschrijving en opdrachten
ip-access-lists Opdrachten waarmee beheerders IP-toegangslijsten kunnen configureren:
create, delete, get, list, replace, update
settings Opdrachten waarmee gebruikers instellingen op werkruimteniveau kunnen beheren:
automatic-cluster-update csp-enablement, default-namespace, esm-enablementrestrict-workspace-admins
token-management Opdrachten waarmee beheerders alle tokens kunnen ophalen en tokens kunnen verwijderen voor andere gebruikers:
create-obo-token, delete, get, list
get-permission-levels, get-permissions, set-permissions, update-permissions
tokens Opdrachten voor het maken, weergeven en intrekken van tokens die kunnen worden gebruikt voor het verifiëren en openen van Databricks REST API's:
create delete list
workspace-conf Opdrachten voor het bijwerken van werkruimte-instellingen:
get-status, set-status

Opdrachten voor ontwikkelhulpprogramma's

Groep Beschrijving en opdrachten
bundel Opdrachten voor het beheren van Databricks Asset Bundles, waarmee u uw Databricks-projecten als code kunt uitdrukken:
deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate
Sync Een lokale map synchroniseren met een werkruimtemap.

Vectorzoekopdrachten

Groep Beschrijving en opdrachten
vector-search-endpoints Opdrachten voor het beheren van vectorzoekeindpunten, die de rekenresources voor het hosten van vectorzoekindexen vertegenwoordigen:
create-endpoint, delete-endpoint, get-endpoint, list-endpoints
vector-search-indexes Opdrachten voor het beheren van vectorzoekindexen, een efficiënte weergave van uw inbeddingsvectoren die real-time en efficiënte benaderde dichtstbijzijnde buur (ANN) zoekopdrachten mogelijk maken.
create-index, , delete-data-vector-indexdelete-index, get-index, , list-indexes, , query-indexsync-indexupsert-data-vector-index

Dashboard-opdrachten

Groep Beschrijving en opdrachten
dashboards Opdrachten voor het wijzigen van dashboards:
create, delete, get, list, restore, update
lakeview Opdrachten die specifieke beheerbewerkingen bieden voor AI/BI-dashboards:
create, , getget-published, migrate, , publish, , trashunpublishupdate

Aanvullende opdrachten

Groep Beschrijving en opdrachten
API Opdrachten voor het indienen van aanvragen bij de Databricks REST API:
delete, get, head, patch, post, put
voltooiing Opdrachten voor het genereren van het script voor automatisch aanvullen voor de opgegeven shell:
bash, fish, powershell, zsh
Configureren Configureer de Databricks CLI.
help Geef gebruiksinformatie voor enige opdracht.
Labs Opdrachten voor het beheren van Databricks Labs-installaties:
clear-cache, , installinstalled, list, , show, , uninstallupgrade
version Haal de versie van de CLI op die momenteel wordt gebruikt.

Globale vlaggen

De volgende vlaggen zijn beschikbaar voor alle Databricks CLI-opdrachten. Houd er rekening mee dat sommige vlaggen niet van toepassing zijn op sommige opdrachten. Raadpleeg de commandoregelhelp voor gedetailleerde informatie over specifieke opdrachten en de bijbehorende vlaggen.

Vlag Beschrijving
-h of --help Help weergeven voor de Databricks CLI, de bijbehorende opdrachtgroep of de bijbehorende opdracht.
-e of --environment string Een tekenreeks die de bundelomgeving vertegenwoordigt die moet worden gebruikt, indien van toepassing voor de gerelateerde opdracht.
--log-file Een tekenreeks die aangeeft waar de uitvoerlogboeken naar geschreven moeten worden. Als deze vlag niet is opgegeven, is het standaardinstelling om uitvoerlogboeken naar stderr te schrijven.
--log-format text om uitvoerlogboeken naar tekst te schrijven of json uitvoerlogboeken naar JSON te schrijven. Als deze vlag niet is opgegeven, worden uitvoerlogboeken geschreven als tekst.
--log-level Een tekenreeks die het niveau van de logboekindeling vertegenwoordigt. Als dit niet is opgegeven, wordt het niveau van de logboekindeling uitgeschakeld.
-o of --output text om uitvoer als tekst te schrijven of json uitvoer als JSON te schrijven. Als deze vlag niet is opgegeven, wordt de uitvoer geschreven als tekst.
-p of --profile Een tekenreeks die het benoemde configuratieprofiel vertegenwoordigt dat in uw .databrickscfg bestand moet worden gebruikt. Als deze vlag niet is opgegeven, wordt het DEFAULT benoemde profiel gebruikt als er een bestaat. U kunt op Tab drukken na --profile of -p om een lijst met bestaande beschikbare configuratieprofielen weer te geven waaruit u kunt kiezen, in plaats van de naam van het configuratieprofiel handmatig in te voeren.
--progress-format De indeling voor voortgangslogboeken die moeten worden weergegeven (defaultde standaardinstelling) of append of inplace ).json