Perintah Databricks CLI
Catatan
Informasi ini berlaku untuk Databricks CLI versi 0.205 ke atas, yang ada di Pratinjau Umum. Untuk menemukan versi Databricks CLI Anda, jalankan databricks -v
.
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 memetakan ke operasi yang didokumenkan dalam referensi REST API Azure Databricks.
Perintah ruang kerja
Grupkan | Deskripsi dan perintah |
---|---|
Fs | Perintah untuk mengelola file dan sistem file:cat , , cp ls , , mkdir ,rm |
git-credentials |
Perintah untuk mendaftarkan token akses pribadi untuk Databricks untuk melakukan operasi atas nama pengguna:create , , delete get , , list ,update |
repos |
Perintah untuk memungkinkan pengguna mengelola repositori git mereka:create , , delete get , , list ,update get-permission-levels , , get-permissions set-permissions ,update-permissions |
secrets |
Perintah untuk mengelola rahasia, cakupan rahasia, dan izin akses:create-scope , , delete-acl delete-scope , delete-secret , get-acl , get-secret , list-acls , list-scopes , list-secrets , , , put-acl put-secret |
workspace |
Perintah untuk mencantumkan, mengimpor, mengekspor, dan menghapus buku catatan dan folder di ruang kerja:delete , , export-dir export , get-status , import , import-dir , , list ,mkdirs get-permission-levels , , get-permissions set-permissions ,update-permissions |
Perintah komputasi
Grupkan | Deskripsi dan perintah |
---|---|
cluster-policies |
Perintah untuk mengontrol kemampuan pengguna untuk mengonfigurasi kluster berdasarkan serangkaian aturan:create , , delete edit , , 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 , edit delete , 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 , , delete get , , list ,update |
instance-pools |
Perintah untuk membuat, mengedit, menghapus, dan mencantumkan kumpulan instans menggunakan instans cloud siap pakai yang mengurangi waktu mulai dan penskalakan otomatis kluster:create , , delete edit , , get ,list get-permission-levels , , get-permissions set-permissions ,update-permissions |
instance-profiles |
Perintah untuk memungkinkan admin menambahkan, mencantumkan, dan menghapus profil instans yang dapat digunakan pengguna untuk meluncurkan kluster dengan:add , , edit list ,remove |
libraries |
Perintah untuk menginstal, menghapus instalan, dan mendapatkan status pustaka pada kluster:all-cluster-statuses , , cluster-status install ,uninstall |
policy-families |
Perintah untuk melihat keluarga kebijakan yang tersedia:get , list |
Perintah pekerjaan
Grupkan | Deskripsi dan perintah |
---|---|
jobs |
Perintah untuk mengelola pekerjaan:cancel-all-runs , , cancel-run , delete create , 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 |
Perintah Tabel Langsung Delta
Grupkan | Deskripsi dan perintah |
---|---|
pipelines |
Perintah untuk membuat, mengedit, menghapus, memulai, dan melihat detail tentang alur: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 |
perintah Pembelajaran Mesin
Grupkan | 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-runs delete-run , delete-tag get-by-name , get-experiment , , get-history , get-runGet , list-artifacts , list-experiments , log-batch , log-inputs , log-metric , , log-param log-model , 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 |
Perintah untuk Registri Model Ruang Kerja:approve-transition-request , , create-comment , create-model , create-transition-request create-model-version , 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-version get-model-version-download-uri get-model list-models , list-transition-requests list-webhooks , rename-model search-model-versions test-registry-webhook set-model-tag search-models reject-transition-request transition-stage update-comment set-model-version-tag , , update-model-version update-model update-webhook get-permission-levels , , get-permissions set-permissions ,update-permissions |
Perintah penyajian real time
Grupkan | Deskripsi dan perintah |
---|---|
serving-endpoints |
Perintah untuk membuat, memperbarui, dan menghapus titik akhir penyajian model:build-logs , , create delete , export-metrics , get , list , logs , patch , put , , , query update-config get-permission-levels , , get-permissions set-permissions ,update-permissions |
Perintah manajemen identitas dan akses
Grupkan | Deskripsi dan perintah |
---|---|
account |
Perintah untuk mengelola akun Databricks: - Identitas dan akses: access-control , groups , service-principals , users , workspace-assignment - Unity Catalog: metastore-assignments , metastores , storage-credentials - Pengaturan: ip-access-lists , network-connectivity , settings - Provisi: 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 , , env login , , profiles ,token |
current-user |
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 , , delete get , 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 , , set update get-permission-levels |
service-principals |
Perintah untuk identitas untuk digunakan dengan pekerjaan, alat otomatis, dan sistem seperti skrip, aplikasi, dan platform CI/CD:create , , delete get , list , , patch ,update |
users |
Perintah untuk identitas pengguna yang dikenali oleh Databricks dan diwakili oleh alamat email:create , , delete get , list , , patch ,update get-permission-levels , , get-permissions set-permissions ,update-permissions |
Perintah terkait SQL
Grupkan | Deskripsi dan perintah |
---|---|
alerts |
Perintah untuk melakukan operasi pada pemberitahuan:create , , delete get , , list ,update |
data-sources |
Perintah untuk membuat objek kueri baru:list |
queries |
Perintah untuk melakukan operasi pada definisi kueri:create , , delete get , list , , restore ,update |
query-history |
Perintah untuk mengakses riwayat kueri melalui gudang SQL:list |
warehouses |
Perintah untuk mengelola gudang SQL, yang merupakan sumber daya komputasi yang memungkinkan Anda menjalankan perintah SQL pada objek data dalam Databricks SQL:create , , edit delete , get , get-workspace-warehouse-config , list , set-workspace-warehouse-config , , start ,stop get-permission-levels , , get-permissions set-permissions ,update-permissions |
Perintah Katalog Unity
Grupkan | Deskripsi dan perintah |
---|---|
artifact-allowlists |
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 bersama:get , update |
catalogs |
Perintah untuk mengelola katalog, lapisan pertama namespace layanan tiga tingkat Katalog Unity:create , , delete get , , list ,update |
connections |
Perintah untuk membuat koneksi ke sumber data eksternal:create , , delete get , , 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 , , delete get , , list ,update |
functions |
Perintah untuk mengelola Fungsi yang Ditentukan Pengguna (UDF) di Unity Catalog:create , , delete get , , list ,update |
grants |
Perintah untuk memberikan akses ke data di Unity Catalog:get , , get-effective update |
metastores |
Perintah untuk mengelola metastores, yang merupakan kontainer objek tingkat atas di Unity Catalog:assign , , create current , delete , get , list , summary , unassign , , update ,update-assignment |
model-versions |
Perintah untuk mengelola versi model. Databricks menyediakan versi MLflow Model Registry yang dihosting di Unity Catalog.delete , , get get-by-alias , , list ,update |
online-tables |
Perintah untuk mengelola tabel online, yang memberikan latensi yang lebih rendah dan akses QPS yang lebih tinggi ke data dari tabel Delta:create , , delete get |
quality-monitors |
Perintah untuk mengelola monitor, yang menghitung dan memantau metrik kualitas data atau model untuk tabel dari waktu ke waktu:create , , delete get , get-refresh , list-refreshes , , run-refresh ,update |
registered-models |
Perintah untuk mengelola model terdaftar. Databricks menyediakan versi MLflow Model Registry yang dihosting di Unity Catalog.create , , delete delete-alias , get , list , , set-alias ,update |
schemas |
Perintah untuk mengelola skema, yang merupakan lapisan kedua dari namespace tiga tingkat Unity Catalog:create , , delete get , , list ,update |
storage-credentials |
Perintah untuk mengelola kredensial penyimpanan, yang merupakan mekanisme autentikasi dan otorisasi untuk mengakses data yang disimpan di penyewa cloud Anda:create , , delete get , list , , update ,validate |
system-schemas |
Perintah untuk mengelola skema sistem, yang merupakan skema yang hidup dalam katalog sistem:disable , , enable list |
table-constraints |
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 namespace layanan tiga tingkat Katalog Unity:delete , , exists get , , list ,list-summaries |
volumes |
Perintah untuk mengelola volume, yang merupakan kemampuan Unity Catalog (UC) untuk mengakses, menyimpan, mengatur, mengatur, dan memproses file:create , , delete list , , read ,update |
workspace-bindings |
Perintah untuk mengelola pengikatan ruang kerja yang dapat diamankan. Securables di Databricks dapat dikonfigurasi sebagai OPEN atau ISOLATED .get , , get-bindings update ,update-bindings |
Perintah berbagi Delta
Grupkan | Deskripsi dan perintah |
---|---|
providers |
Perintah untuk mengelola penyedia data, yang mewakili organisasi yang berbagi data:create , , delete get , list , , list-shares ,update |
recipient-activation |
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 |
recipients |
Perintah untuk mengelola penerima, yang Anda buat menggunakan :method:recipients/create untuk mewakili organisasi yang ingin Anda izinkan aksesnya ke berbagi:create , , delete get , list , , rotate-token ,update share-permissions |
shares |
Perintah untuk mengelola berbagi, yang merupakan kontainer yang dibuat dengan :method:shares/create :create , , delete get , , list ,update share-permissions , update-permissions |
Perintah pengaturan
Grupkan | Deskripsi dan perintah |
---|---|
ip-access-lists |
Perintah untuk memungkinkan admin mengonfigurasi daftar akses IP:create , , delete get , list , , replace ,update |
settings |
Perintah untuk memungkinkan pengguna mengelola pengaturan di tingkat ruang kerja:automatic-cluster-update , , csp-enablement default-namespace , , esm-enablement ,restrict-workspace-admins |
token-management |
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 |
tokens |
Perintah untuk membuat, mencantumkan, dan mencabut token yang dapat digunakan untuk mengautentikasi dan mengakses REST API Databricks:create , , delete list |
workspace-conf |
Perintah untuk memperbarui pengaturan ruang kerja:get-status , set-status |
perintah Alat pengembang
Grupkan | Deskripsi dan perintah |
---|---|
bundel | Perintah untuk mengelola Bundel Aset Databricks, yang memungkinkan Anda mengekspresikan proyek Databricks Anda sebagai kode:deploy , , destroy deployment , generate , init , run , schema , , sync ,validate |
Sync | Menyinkronkan direktori lokal ke direktori ruang kerja. |
Perintah pencarian vektor
Grupkan | Deskripsi dan perintah |
---|---|
vector-search-endpoints |
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 efisien dari vektor penyematan Anda yang mendukung kueri pencarian real time dan efisien perkiraan tetangga terdekat (ANN):create-index , , delete-index delete-data-vector-index , get-index , list-indexes , query-index , , sync-index ,upsert-data-vector-index |
Perintah dasbor
Grupkan | Deskripsi dan perintah |
---|---|
dashboards |
Perintah untuk memodifikasi dasbor:create , , delete get , list , , restore ,update |
lakeview |
Perintah yang menyediakan operasi manajemen tertentu untuk dasbor AI/BI:create , , get-published get , migrate , publish , trash , , unpublish ,update |
Perintah tambahan
Grupkan | Deskripsi dan perintah |
---|---|
api | Perintah untuk membuat permintaan ke Databricks REST API:delete , , get head , patch , , post ,put |
Penyelesaian | Perintah untuk menghasilkan skrip pelengkapan otomatis untuk shell yang ditentukan:bash , , fish powershell ,zsh |
Mengkonfigurasi | Konfigurasikan Databricks CLI. |
help |
Informasi penggunaan output untuk perintah apa pun. |
Labs | Perintah untuk mengelola penginstalan Databricks Labs:clear-cache , , install installed , list , show , , uninstall ,upgrade |
version |
Ambil versi CLI yang saat ini sedang digunakan. |
Bendera global
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.
Bendera | Deskripsi |
---|---|
-h atau --help |
Tampilkan bantuan untuk Databricks CLI atau grup perintah terkait atau perintah terkait. |
-e atau --environment string |
String yang mewakili lingkungan bundel yang akan digunakan jika berlaku untuk perintah terkait. |
--log-file |
String yang mewakili untuk menulis log output. Jika bendera ini tidak ditentukan, maka defaultnya adalah menulis log output ke stderr. |
--log-format |
text untuk menulis log output ke teks atau json menulis log output ke JSON. Jika bendera ini tidak ditentukan, maka log output ditulis sebagai teks. |
--log-level |
String yang mewakili tingkat format log. Jika tidak ditentukan maka tingkat format log dinonaktifkan. |
-o atau --output |
text untuk menulis output sebagai teks atau json menulis output sebagai JSON. Jika bendera ini tidak ditentukan, maka output ditulis sebagai teks. |
-p atau --profile |
String yang mewakili profil konfigurasi bernama untuk digunakan dalam file Anda .databrickscfg . Jika bendera ini tidak ditentukan, profil DEFAULT bernama akan digunakan jika ada. Anda dapat menekan Tab setelah --profile atau -p untuk menampilkan daftar profil konfigurasi yang tersedia untuk dipilih alih-alih memasukkan nama profil konfigurasi secara manual. |
--progress-format |
Format untuk log kemajuan yang akan ditampilkan (default (default) atau append atau inplace atau json ). |