Bagikan melalui

Perintah Databricks CLI

  • Artikel

Catatan

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

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

Perintah komputasi

Grup 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, 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, 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, dan mendapatkan status pustaka pada kluster:
all-cluster-statuses, cluster-status, install, uninstall
policy-families Komando untuk melihat kelompok kebijakan yang tersedia:
get, list

Perintah pekerjaan

Grup Deskripsi dan perintah
jobs Perintah untuk mengelola pekerjaan:
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

Perintah DLT

Grup 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

Grup 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-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 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

Grup 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

Grup 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
  • 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, 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 yang digunakan dengan tugas, alat yang terotomatisasi, 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
Grup 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, delete, edit, 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

Grup 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 standar:
get, update
catalogs Perintah untuk mengelola katalog, yang merupakan lapisan pertama dari namespace tiga tingkat pada 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 User-Defined Functions (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 dari namespace 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 aman. Securables di Databricks dapat dikonfigurasi sebagai OPEN atau ISOLATED.
get, get-bindings, update, update-bindings

Perintah berbagi Delta

Grup 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 dengan menggunakan :method:recipients/create untuk mewakili organisasi yang ingin Anda izinkan mengakses 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

Grup 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

Grup Deskripsi dan perintah
bundel Perintah untuk mengelola Bundel Aset Databricks, yang memungkinkan Anda mengekspresikan proyek Databricks Anda sebagai kode:
deploy, deployment, destroy, generate, init, open, run, schema, summary, sync, validate
sinkronisasi Menyinkronkan direktori lokal ke direktori ruang kerja.

Perintah pencarian vektor

Grup 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 vektor penyematan yang efisien yang mendukung kueri pencarian real-time dan estimasi efisien tetangga terdekat (ANN):
create-index, delete-data-vector-index, delete-index, get-index, list-indexes, query-index, sync-index, upsert-data-vector-index

Perintah dasbor

Grup 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, get-published, migrate, publish, trash, unpublish, update

Perintah tambahan

Grup 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
Konfigurasi Konfigurasikan Databricks CLI.
help Informasi penggunaan keluaran untuk setiap perintah.
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 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.

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 Sebuah string yang mewakili tempat 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 Untaian yang menggambarkan tingkat format log. Jika tidak ditentukan, maka tingkat format log akan 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 di dalam file Anda .databrickscfg. Jika bendera ini tidak ditentukan, profil bernama DEFAULT 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).