Bagikan melalui


Perintah Databricks CLI

Note

Informasi ini berlaku untuk Databricks CLI versi 0.205 ke atas. Databricks CLI ada di Pratinjau Publik.

Penggunaan Databricks CLI tunduk pada Lisensi Databricks dan Pemberitahuan Privasi Databricks, termasuk ketentuan Data Penggunaan apa pun.

Artikel ini menyediakan informasi tentang perintah Databricks CLI yang tersedia. Informasi ini melengkapi bantuan baris perintah. Untuk informasi selengkapnya tentang menginstal dan menggunakan Databricks CLI, lihat Menginstal atau memperbarui databricks CLI dan Apa itu Databricks CLI?.

Databricks CLI menyertakan grup perintah yang tercantum dalam tabel berikut. Grup perintah berisi sekumpulan perintah terkait, yang juga dapat berisi subperintah. Untuk menghasilkan informasi penggunaan dan sintaks untuk grup perintah, perintah individual, atau sub-perintah:

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

Banyak perintah CLI berhubungan dengan operasi yang didokumentasikan dalam referensi API REST Azure Databricks.

Perintah ruang kerja

Group Deskripsi dan perintah
fs Perintah untuk mengelola file dan sistem file:
cat, , cpls, , mkdir,rm
git-credentials Perintah untuk mendaftarkan token akses pribadi untuk Databricks untuk melakukan operasi atas nama pengguna:
create, , deleteget, , list,update
repos Perintah untuk memungkinkan pengguna mengelola repositori git mereka:
create, , deleteget, , list,update
get-permission-levels,get-permissions,set-permissions,update-permissions
secrets Perintah untuk mengelola rahasia, cakupan rahasia, dan izin akses:
create-scope, , delete-acldelete-scope, delete-secret, get-acl, get-secret, list-acls, list-scopes, list-secrets, , , put-aclput-secret
workspace Perintah untuk mencantumkan, mengimpor, mengekspor, dan menghapus buku catatan dan folder di ruang kerja:
delete, , exportexport-dir, get-status, import, import-dir, , list,mkdirs
get-permission-levels,get-permissions,set-permissions,update-permissions

Perintah komputasi

Group Deskripsi dan perintah
kebijakan kluster Perintah untuk mengontrol kemampuan pengguna untuk mengonfigurasi kluster berdasarkan serangkaian aturan:
create, , deleteedit, , get,list
get-permission-levels,get-permissions,set-permissions,update-permissions
clusters Perintah yang memungkinkan Anda membuat, memulai, mengedit, mencantumkan, mengakhiri, dan menghapus kluster:
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 Perintah yang memungkinkan administrator ruang kerja mengonfigurasi skrip inisialisasi global untuk ruang kerja mereka:
create, , deleteget, , list,update
kumpulan instans Perintah untuk membuat, mengedit, menghapus, dan mencantumkan kumpulan instans menggunakan instans cloud siap pakai yang mengurangi waktu mulai dan penskalakan otomatis kluster:
create, , deleteedit, , get,list
get-permission-levels,get-permissions,set-permissions,update-permissions
profil instans Perintah untuk memungkinkan admin menambahkan, mencantumkan, dan menghapus profil instans yang dapat digunakan pengguna untuk meluncurkan kluster dengan:
add,edit,list,remove
Perpustakaan Perintah untuk menginstal, menghapus, dan mendapatkan status pustaka pada kluster:
all-cluster-statuses,cluster-status,install,uninstall
keluarga kebijakan Komando untuk melihat kelompok kebijakan yang tersedia:
get, list

Perintah pekerjaan

Group Deskripsi dan perintah
jobs Perintah untuk mengelola pekerjaan:
cancel-all-runs, , cancel-run, createdelete, delete-run, export-runget, , get-run, get-run-output, list, list-runs, repair-run, , reset, run-now, , submit,update
get-permission-levels,get-permissions,set-permissions,update-permissions

Perintah Alur Deklaratif Lakeflow Spark

Group Deskripsi dan perintah
pipelines Perintah untuk membuat, mengedit, menghapus, memulai, dan melihat detail tentang alur:
create, , deleteget, get-update, list-pipeline-events, list-pipelines, list-updates, start-update, , stop,update
get-permission-levels,get-permissions,set-permissions,update-permissions

perintah Pembelajaran Mesin

Group Deskripsi dan perintah
experiments Perintah untuk berinteraksi dengan eksperimen, yang merupakan unit utama organisasi di MLflow; semua eksekusi MLflow milik eksperimen:
create-experiment, , create-run, delete-experiment, delete-rundelete-runs, delete-tagget-by-name, get-experiment, , get-history, get-runGet, list-artifacts, list-experiments, log-batch, log-inputs, log-metric, , log-modellog-param, restore-experiment, restore-run, restore-runs, search-experiments, search-runs, set-experiment-tag, set-tag, update-experimentupdate-run
get-permission-levels,get-permissions,set-permissions,update-permissions
rekayasa fitur Perintah untuk menjalankan fitur di Databricks Feature Store, yang menyediakan registri pusat untuk fitur yang digunakan dalam model AI dan ML Anda.
create-feature, , delete-featureget-feature, , list-features,update-feature
registri model Perintah untuk Registri Model Ruang Kerja:
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

Perintah layanan waktu nyata

Group Deskripsi dan perintah
titik akhir penyajian Perintah untuk membuat, memperbarui, dan menghapus titik akhir penyajian model:
build-logs, , createdelete, export-metrics, get, list, logs, patch, put, , , queryupdate-config
get-permission-levels,get-permissions,set-permissions,update-permissions

Perintah manajemen identitas dan akses

Group Deskripsi dan perintah
account Perintah untuk mengelola akun Databricks:
  • Identitas dan akses: access-control, groups, service-principals, users, workspace-assignment
  • Katalog Unity: metastore-assignments, metastores, storage-credentials
  • Pengaturan: ip-access-lists, network-connectivity, settings
  • Penyediaan: credentials, encryption-keys, networks, private-access, storage, vpc-endpoints, workspaces
  • Penagihan: "billable-usage", "log-delivery"
  • OAuth: custom-app-integration, o-auth-published-apps, published-app-integration, service-principal-secrets
auth Perintah untuk autentikasi:
describe, , envlogin, , profiles,token
pengguna saat ini Perintah untuk mengambil informasi tentang pengguna atau perwakilan layanan yang saat ini diautentikasi:
me
groups Perintah untuk grup yang menyederhanakan manajemen identitas, memudahkan untuk menetapkan akses ke ruang kerja Databricks, data, dan objek yang dapat diamankan lainnya:
create, , deleteget, list, , patch,update
permissions Perintah untuk membuat baca, tulis, edit, perbarui, dan kelola akses untuk berbagai pengguna pada objek dan titik akhir yang berbeda:
get, , setupdate
get-permission-levels
perwakilan layanan Perintah untuk identitas yang digunakan dengan tugas, alat yang terotomatisasi, dan sistem, seperti skrip, aplikasi, dan platform CI/CD:
create, , deleteget, list, , patch,update
users Perintah untuk identitas pengguna yang dikenali oleh Databricks dan diwakili oleh alamat email:
create, , deleteget, list, , patch,update
get-permission-levels,get-permissions,set-permissions,update-permissions
Group Deskripsi dan perintah
alerts Perintah untuk melakukan operasi pada pemberitahuan:
create, , deleteget, , list,update
alerts-legacy Perintah untuk melakukan operasi pada peringatan lama.
create, , deleteget, , list,update
sumber data Perintah untuk membuat objek kueri baru:
list
queries Perintah untuk melakukan operasi pada definisi kueri:
create, , deleteget, list, , restore,update
kueri-warisan Perintah untuk melakukan operasi pada definisi kueri warisan:
create, , deleteget, list, , restore,update
riwayat kueri Perintah untuk mengakses riwayat kueri melalui gudang SQL:
list
Gudang Perintah untuk mengelola gudang SQL, yang merupakan sumber daya komputasi yang memungkinkan Anda menjalankan perintah SQL pada objek data dalam Databricks SQL:
create, , deleteedit, get, get-workspace-warehouse-config, list, set-workspace-warehouse-config, , start,stop
get-permission-levels,get-permissions,set-permissions,update-permissions

Perintah dari Katalog Unity

Group Deskripsi dan perintah
daftar artifact-allow Perintah untuk mengelola daftar izin artefak. Di Databricks Runtime 13.3 ke atas, Anda dapat menambahkan pustaka dan skrip init ke daftar yang diizinkan di UC sehingga pengguna dapat memanfaatkan artefak ini pada komputasi yang dikonfigurasi dengan mode akses standar:
get, update
catalogs Perintah untuk mengelola katalog, yang merupakan lapisan pertama dari tiga tingkat namespace Katalog Unity.
create, , deleteget, , list,update
Kredensial Perintah untuk mengelola kredensial, yang merupakan mekanisme autentikasi dan otorisasi untuk mengakses layanan di penyewa cloud Anda. Setiap kredensial tunduk pada kebijakan kontrol akses Katalog Unity yang mengontrol pengguna dan grup mana yang dapat mengakses kredensial.
create-credential, , delete-credentialgenerate-temporary-service-credential, get-credential, list-credentials, , update-credential,validate-credential
connections Perintah untuk membuat koneksi ke sumber data eksternal:
create, , deleteget, , list,update
external-locations Perintah untuk mengelola lokasi eksternal, yang menggabungkan jalur penyimpanan cloud dengan kredensial penyimpanan yang mengotorisasi akses ke jalur penyimpanan cloud:
create, , deleteget, , list,update
functions Perintah untuk mengelola fungsi yang ditentukan pengguna (UDF) di Unity Catalog:
create, , deleteget, , list,update
grants Perintah untuk memberikan akses ke data di Unity Catalog:
get, , get-effectiveupdate
metastores Perintah untuk mengelola metastores, yang merupakan kontainer objek tingkat atas di Unity Catalog:
assign, , createcurrent, delete, get, list, summary, unassign, , update,update-assignment
versi model Perintah untuk mengelola versi model. Databricks menyediakan versi MLflow Model Registry yang dihosting di Unity Catalog.
delete, , getget-by-alias, , list,update
tabel online Perintah untuk mengelola tabel online, yang memberikan latensi yang lebih rendah dan akses QPS yang lebih tinggi ke data dari tabel Delta:
create, , deleteget
monitor kualitas Perintah untuk mengelola monitor, yang menghitung dan memantau metrik kualitas data atau model untuk tabel dari waktu ke waktu:
create, , deleteget, get-refresh, list-refreshes, , run-refresh,update
model terdaftar Perintah untuk mengelola model terdaftar. Databricks menyediakan versi MLflow Model Registry yang dihosting di Unity Catalog.
create, , deletedelete-alias, get, list, , set-alias,update
kuota sumber daya Perintah untuk mengelola kuota sumber daya yang diberlakukan oleh Unity Catalog pada semua objek yang dapat diamankan, yang membatasi jumlah sumber daya yang dapat dibuat.
get-quota, list-quotas
schemas Perintah untuk mengelola skema, yang merupakan lapisan kedua dari namespace tiga tingkat Unity Catalog:
create, , deleteget, , list,update
kredensial penyimpanan Perintah untuk mengelola kredensial penyimpanan, yang merupakan mekanisme autentikasi dan otorisasi untuk mengakses data yang disimpan di penyewa cloud Anda:
create, , deleteget, list, , update,validate
skema sistem Perintah untuk mengelola skema sistem, yang merupakan skema yang hidup dalam katalog sistem:
disable, , enablelist
batasan tabel Perintah untuk mengelola kunci primer dan batasan kunci asing yang mengodekan hubungan antar bidang dalam tabel:
create, delete
tables Perintah untuk mengelola tabel, yang berada di lapisan ketiga dari namespace tiga tingkat Katalog Unity.
delete, , existsget, , list,list-summaries
info masuk tabel sementara Perintah untuk mengelola kredensial berumur pendek untuk tabel sementara, yaitu kredensial dengan hak akses terbatas yang digunakan untuk mengakses lokasi penyimpanan awan tempat data tabel disimpan di Databricks.
generate-temporary-table-credentials
volumes Perintah untuk mengelola volume, yang merupakan kemampuan Unity Catalog (UC) untuk mengakses, menyimpan, mengatur, mengatur, dan memproses file:
create, , deletelist, , read,update
pengikatan ruang kerja Perintah untuk mengelola pengikatan ruang kerja yang aman. Securables di Databricks dapat dikonfigurasi sebagai OPEN atau ISOLATED.
get,get-bindings,update,update-bindings

Perintah berbagi Delta

Group Deskripsi dan perintah
providers Perintah untuk mengelola penyedia data, yang mewakili organisasi yang berbagi data:
create, , deleteget, list, , list-shares,update
penerima-aktivasi Perintah untuk mengelola aktivasi penerima, yang hanya berlaku dalam model berbagi terbuka di mana objek penerima memiliki jenis autentikasi TOKEN:
get-activation-url-info, retrieve-token
Penerima Perintah untuk mengelola penerima, yang Anda buat dengan menggunakan :method:recipients/create untuk mewakili organisasi yang ingin Anda izinkan mengakses berbagi:
create, , deleteget, list, , rotate-token,update
share-permissions
Saham Perintah untuk mengelola berbagi, yang merupakan kontainer yang dibuat dengan :method:shares/create:
create, , deleteget, list, , list-shares,update
share-permissions, update-permissions

Perintah pengaturan

Group Deskripsi dan perintah
ip-access-lists Perintah untuk memungkinkan admin mengonfigurasi daftar akses IP:
create, , deleteget, list, , replace,update
tujuan pemberitahuan Perintah untuk mengelola saluran pemberitahuan pada ruang kerja:
create, , deleteget, , list,update
settings Perintah untuk memungkinkan pengguna mengelola pengaturan di tingkat ruang kerja:
automatic-cluster-update, , csp-enablementdefault-namespace, , esm-enablement,restrict-workspace-admins
manajemen token Perintah yang memungkinkan administrator mendapatkan semua token dan menghapus token untuk pengguna lain:
create-obo-token,delete,get,list
get-permission-levels,get-permissions,set-permissions,update-permissions
Token Perintah untuk membuat, mencantumkan, dan mencabut token yang dapat digunakan untuk mengautentikasi dan mengakses REST API Databricks:
create, , deletelist
workspace-conf Perintah untuk memperbarui pengaturan ruang kerja:
get-status, set-status

Perintah alat pengembang

Group Deskripsi dan perintah
bundle Perintah untuk mengelola Bundel Aset Databricks, yang memungkinkan Anda mengekspresikan proyek Databricks Anda sebagai kode:
deploy, , deploymentdestroy, generate, init, open, plan, run, schema, , summary, , syncvalidate
sync Menyinkronkan direktori lokal ke direktori ruang kerja.

Perintah pencarian vektor

Group Deskripsi dan perintah
titik akhir pencarian vektor Perintah untuk mengelola titik akhir pencarian vektor, yang mewakili sumber daya komputasi untuk menghosting indeks pencarian vektor:
create-endpoint,delete-endpoint,get-endpoint,list-endpoints
vector-search-indexes Perintah untuk mengelola indeks pencarian vektor, representasi vektor penyematan yang efisien yang mendukung kueri pencarian real-time dan estimasi efisien tetangga terdekat (ANN):
create-index, , delete-data-vector-indexdelete-index, get-index, list-indexes, query-index, , sync-index,upsert-data-vector-index

Perintah dasbor

Group Deskripsi dan perintah
dashboards Perintah untuk memodifikasi dasbor lama.
create, , deleteget, list, , restore,update
genie Perintah untuk memodifikasi Genie, yang memberikan pengalaman tanpa kode untuk pengguna bisnis, didukung oleh AI/BI:
create-message, , execute-message-attachment-queryget-message, get-message-attachment-query-result, , get-spaced,start-conversation
Lakeview Perintah yang menyediakan operasi manajemen tertentu untuk dasbor AI/BI:
create, , create-schedule, create-subscriptiondelete-schedule, delete-subscription, getget-published, , get-schedule, get-subscription, list, list-schedules, list-subscriptions, migrate, , publish, trash, unpublish, update,update-schedule

Perintah di marketplace

Group Deskripsi dan perintah
pemenuhan konsumen Perintah untuk mengelola pemenuhan, yang merupakan entitas yang memungkinkan konsumen untuk mempratinjau penginstalan.
get, list
penginstalan konsumen Perintah untuk mengelola penginstalan, sebagai entitas yang memungkinkan konsumen berinteraksi dengan listing di Databricks Marketplace.
create, , deletelist, , list-listing-installations,update
daftar konsumen Perintah untuk mengelola daftar konsumen Marketplace Databricks:
batch-get,get,list,search
permintaan personalisasi konsumen Perintah untuk mengelola permintaan personalisasi, yang memungkinkan pelanggan berinteraksi dengan alur pencatatan Marketplace yang dipersonalisasi.
create, , getlist
penyedia konsumen Perintah untuk mengelola penyedia, yaitu entitas yang mempublikasikan daftar ke Marketplace.
batch-get, , getlist
filter pertukaran penyedia Perintah untuk mengelola filter pertukaran Marketplace, yang mengumpulkan grup mana yang dapat mengakses pertukaran.
create,delete,list,update
pertukaran penyedia Perintah untuk mengelola pertukaran Marketplace, yang memungkinkan penyedia berbagi daftar mereka dengan sekumpulan pelanggan yang dikumpulkan.
add-listing-to-exchange, , createdelete, delete-listing-from-exchange, get, list, list-exchanges-for-listing, , list-listings-for-exchange,update
provider-files Perintah untuk mengelola file Marketplace, seperti pratinjau buku catatan dan ikon penyedia.
create,delete,get,list
daftar penyedia Perintah untuk mengelola daftar penyedia:
create, , deleteget, , list,update
permintaan personalisasi penyedia Perintah untuk mengelola permintaan personalisasi, yang merupakan alternatif dari daftar yang tersedia secara instan.
list, update
provider-provider-analytics-dashboards Perintah untuk mengelola analitik templat untuk penyedia:
create,get,get-latest-version,update
penyedia penyedia Perintah untuk mengatur penyedia yang menangani aset di Marketplace.
create, , deleteget, , list,update

Perintah aplikasi

Group Deskripsi dan perintah
apps Perintah untuk mengelola aplikasi Databricks, yang berjalan langsung pada instans Databricks Anda, berintegrasi dengan data Anda, menggunakan dan memperluas layanan Databricks, dan memungkinkan pengguna berinteraksi melalui akses menyeluruh.
create, , deletedeploy, get, get-deployment, list, list-deployments, logs, run-local, , start, , stopupdate

Perintah bersihkan ruangan

Group Deskripsi dan perintah
aset kamar bersih Perintah untuk mengelola aset ruangan bersih, yang merupakan objek data dan kode seperti tabel, volume, dan notebook yang dibagikan dengan ruang bersih.
create, , deleteget, , list,update
clean-room-task-runs Perintah untuk mengelola pelaksanaan tugas clean room, yaitu eksekusi dari notebook di dalam clean room.
list
kamar bersih Perintah untuk mengelola kamar bersih. Kamar bersih menggunakan Delta Sharing dan komputasi tanpa server untuk menyediakan lingkungan yang aman dan melindungi privasi di mana beberapa pihak dapat bekerja sama pada data perusahaan sensitif tanpa akses langsung ke data satu sama lain.
create, , create-output-catalogdelete, get, , list,update

Perintah database

Group Deskripsi dan perintah
basisdata Perintah untuk mengelola instans database Lakebase.
create-database-catalog, , create-database-instance, create-database-tablecreate-synced-database-table, delete-database-catalog, delete-database-instancedelete-database-table, , delete-synced-database-table, find-database-instance-by-uid, generate-database-credential, get-database-catalog, get-database-instance, , get-database-table, get-synced-database-table, , list-database-instances,update-database-instance

Perintah tambahan

Group Deskripsi dan perintah
api Perintah untuk membuat permintaan ke Databricks REST API:
delete, , gethead, patch, , post,put
completion Perintah untuk menghasilkan skrip pelengkapan otomatis untuk shell yang ditentukan:
bash,fish,powershell,zsh
configure Konfigurasikan Databricks CLI.
help Informasi ringkasan output untuk semua perintah Databricks CLI.
labs Perintah untuk mengelola penginstalan Databricks Labs:
clear-cache, , installinstalled, list, show, , uninstall,upgrade
version Ambil versi CLI yang saat ini sedang digunakan.

Bendera dunia

Bendera berikut tersedia untuk semua perintah Databricks CLI. Perhatikan bahwa beberapa bendera tidak berlaku untuk beberapa perintah. Untuk informasi terperinci tentang perintah tertentu dan benderanya, lihat bantuan baris perintah.

--debug

  Apakah debug logging ingin diaktifkan?

-h atau --help

    Tampilkan bantuan untuk Databricks CLI atau grup perintah terkait atau perintah terkait.

--log-file tali

    String yang mewakili file yang akan digunakan untuk menulis log output. Jika bendera ini tidak ditentukan, maka defaultnya adalah menulis log output ke stderr.

--log-format Format

    Jenis format log, text atau json. Nilai defaultnya adalah text.

--log-level tali

    Untaian yang menggambarkan tingkat format log. Jika tidak ditentukan, maka tingkat format log akan dinonaktifkan.

-o, --output jenis

    Jenis output perintah, text atau json. Nilai defaultnya adalah text.

-p, --profile tali

    Nama profil dalam file ~/.databrickscfg yang digunakan untuk menjalankan perintah. Jika bendera ini tidak ditentukan maka jika ada, profil bernama DEFAULT digunakan.

--progress-format Format

    Format untuk menampilkan log kemajuan: default, , append, inplaceatau json

-t, --target tali

    Jika berlaku, target bundel yang akan digunakan