grup perintah apps

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.

apps Grup perintah dalam Databricks CLI memungkinkan Anda mengelola aplikasi. Aplikasi berjalan langsung pada instans Databricks pelanggan, berintegrasi dengan data mereka, menggunakan dan memperluas layanan Databricks, dan mengizinkan pengguna berinteraksi melalui single sign-on. Lihat Aplikasi Databricks.

pembuatan aplikasi databricks

Buat aplikasi baru.

databricks apps create NAME [flags]

Arguments

NAME

    Nama aplikasi. Nama hanya boleh berisi karakter alfanumerik huruf kecil dan tanda hubung. Ini harus unik dalam ruang kerja.

Opsi

--budget-policy-id string

    ID kebijakan anggaran untuk aplikasi.

--compute-size ComputeSize

    Ukuran komputasi untuk aplikasi. Nilai yang didukung: LARGE, MEDIUM.

--description string

    Deskripsi aplikasi.

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--no-compute

    Jika true, aplikasi tidak akan dimulai setelah pembuatan.

--no-wait

    Jangan menunggu untuk mencapai status ACTIVE.

--space string

    Nama ruang tempat aplikasi ini berada.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status ACTIVE (default 20m0s).

--usage-policy-id string

    ID kebijakan penggunaan untuk aplikasi.

Bendera global

Examples

Contoh berikut membuat aplikasi dasar:

databricks apps create my-analytics-app --description "Analytics dashboard app"

Contoh berikut membuat aplikasi tanpa memulainya:

databricks apps create my-data-app --description "Data processing app" --no-compute

Contoh berikut membuat aplikasi dengan batas waktu kustom:

databricks apps create my-ml-app --description "Machine learning app" --timeout 30m

pembaruan pembuatan aplikasi databricks

Membuat pembaruan aplikasi dan memulai proses pembaruan. Proses pembaruan tidak sinkron dan status pembaruan dapat diperiksa dengan metode GetAppUpdate.

databricks apps create-update APP_NAME UPDATE_MASK [flags]

Arguments

APP_NAME

    Nama aplikasi.

UPDATE_MASK

    Masker bidang harus berupa string tunggal, dengan beberapa bidang dipisahkan oleh koma (tanpa spasi). Jalur bidang relatif terhadap objek sumber daya, menggunakan titik (.) untuk menavigasi sub-bidang (misalnya, author.given_name). Spesifikasi elemen secara berurutan atau bidang peta tidak diizinkan, karena hanya seluruh bidang koleksi yang dapat ditentukan. Nama bidang harus sama persis dengan nama bidang sumber daya.

    Masker bidang * menunjukkan penggantian penuh. Disarankan untuk selalu secara eksplisit mencantumkan bidang yang diperbarui dan menghindari penggunaan * kartubebas, karena dapat menyebabkan hasil yang tidak diinginkan jika API berubah di masa mendatang.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--no-wait

    Anda tidak perlu menunggu sampai status BERHASIL tercapai.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status BERHASIL (default 20m0s).

Bendera global

Examples

Contoh berikut membuat pembaruan aplikasi dengan masker bidang tertentu:

databricks apps create-update my-analytics-app "description" --json '{"description": "Updated app description"}'

Contoh berikut membuat pembaruan aplikasi tanpa menunggu penyelesaian:

databricks apps create-update my-data-app "budget_policy_id" --json '{"budget_policy_id": "new-policy-123"}' --no-wait

Contoh berikut membuat pembaruan aplikasi dengan batas waktu kustom:

databricks apps create-update my-ml-app "description,budget_policy_id" --json '{"description": "Updated ML app", "budget_policy_id": "ml-policy-456"}' --timeout 30m

hapus aplikasi databricks

Menghapus aplikasi.

Saat dijalankan dari direktori proyek Databricks Apps (berisi databricks.yml) tanpa NAME argumen, perintah ini menghancurkan semua sumber daya yang disebarkan oleh proyek. NAME Saat argumen disediakan atau saat tidak berada di direktori proyek, menghapus aplikasi yang ditentukan menggunakan API secara langsung.

databricks apps delete [NAME] [flags]

Arguments

NAME

    Nama aplikasi. Diperlukan saat tidak berada dalam direktori proyek. Saat disediakan dalam direktori proyek, menggunakan penghapusan API alih-alih menghancurkan proyek.

Opsi

--auto-approve

    Lewati persetujuan interaktif untuk menghapus sumber daya dan file.

--force-lock

    Paksa akuisisi kunci penyebaran.

Bendera global

Examples

Contoh berikut menghapus aplikasi:

databricks apps delete my-analytics-app

Contoh berikut menghancurkan semua sumber daya proyek dari direktori proyek:

databricks apps delete

Contoh berikut menghancurkan sumber daya proyek dengan persetujuan otomatis:

databricks apps delete --auto-approve

lakukan penyebaran aplikasi databricks

Membuat penyebaran aplikasi.

Saat dijalankan dari direktori proyek Databricks Apps (berisi databricks.yml) tanpa APP_NAME argumen, perintah ini menjalankan alur penyebaran yang ditingkatkan yang memvalidasi proyek, menyebarkannya ke ruang kerja, dan menjalankan aplikasi. APP_NAME Saat argumen disediakan atau saat tidak berada dalam direktori proyek, membuat penyebaran aplikasi menggunakan API secara langsung.

databricks apps deploy [APP_NAME] [flags]

Arguments

APP_NAME

    Nama aplikasi. Diperlukan saat tidak berada dalam direktori proyek. Saat disediakan dalam direktori proyek, menggunakan penyebaran API alih-alih penyebaran proyek.

Opsi

--deployment-id string

    Id unik penyebaran.

--force

    Ambil alih paksa validasi cabang Git.

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--mode AppDeploymentMode

    Mode penyebaran yang akan mengelola kode sumber. Nilai yang didukung: AUTO_SYNC, SNAPSHOT.

--no-wait

    Anda tidak perlu menunggu sampai status BERHASIL tercapai.

--skip-tests

    Lewati pengujian yang berjalan selama validasi (default true).

--skip-validation

    Lewati validasi proyek (build, typecheck, lint).

--source-code-path string

    Jalur sistem file di ruang kerja dari kode sumber yang digunakan untuk membuat penggelaran aplikasi.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status BERHASIL (default 20m0s).

Bendera global

Examples

Contoh berikut membuat penyebaran dengan mode sinkronisasi otomatis:

databricks apps deploy my-analytics-app --source-code-path /Workspace/Users/someone@example.com/my-app --mode AUTO_SYNC

Contoh berikut membuat penyebaran dengan mode rekam jepret:

databricks apps deploy my-data-app --source-code-path /Workspace/Users/someone@example.com/data-app --mode SNAPSHOT

Contoh berikut membuat penyebaran dengan ID penyebaran kustom:

databricks apps deploy my-ml-app --deployment-id "v1.2.3" --source-code-path /Workspace/Users/someone@example.com/ml-app

dapatkan aplikasi databricks

Dapatkan informasi untuk aplikasi dengan nama yang disediakan.

databricks apps get NAME [flags]

Arguments

NAME

    Nama aplikasi.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi aplikasi:

databricks apps get my-analytics-app

Contoh berikut mendapatkan informasi aplikasi dalam format JSON:

databricks apps get my-data-app --output json

Contoh berikut mendapatkan informasi aplikasi menggunakan profil tertentu:

databricks apps get my-ml-app --profile production

get-deployment aplikasi databricks

Dapatkan informasi untuk penyebaran aplikasi dengan nama dan ID penyebaran yang telah disediakan.

databricks apps get-deployment APP_NAME DEPLOYMENT_ID [flags]

Arguments

APP_NAME

    Nama aplikasi.

DEPLOYMENT_ID

    Id unik penyebaran.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan informasi penyebaran:

databricks apps get-deployment my-analytics-app v1.0.0

Contoh berikut mendapatkan informasi penyebaran dalam format JSON:

databricks apps get-deployment my-data-app v2.1.0 --output json

Contoh berikut mendapatkan informasi penyebaran menggunakan profil tertentu:

databricks apps get-deployment my-ml-app latest --profile production

get-update aplikasi databricks

Dapatkan status pembaruan aplikasi.

databricks apps get-update APP_NAME [flags]

Arguments

APP_NAME

    Nama aplikasi.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan status pembaruan aplikasi:

databricks apps get-update my-analytics-app

Contoh berikut mendapatkan status pembaruan dalam format JSON:

databricks apps get-update my-data-app --output json

Contoh berikut mendapatkan status pembaruan menggunakan profil tertentu:

databricks apps get-update my-ml-app --profile production

impor aplikasi databricks

(Eksperimental) Impor aplikasi Databricks yang ada sebagai bundel.

Impor aplikasi Databricks yang ada dan konversikan ke konfigurasi bundel. Perintah ini membuat direktori bundel baru dengan konfigurasi aplikasi, mengunduh kode sumber aplikasi, mengikat bundel ke aplikasi yang ada, dan menyebarkannya menggunakan mode penyebaran langsung.

databricks apps import [flags]

Arguments

None

Opsi

--cleanup

    Bersihkan folder aplikasi sebelumnya dan semua kontennya.

--force-import

    Paksa impor ulang aplikasi yang sudah diimpor (hanya berfungsi untuk aplikasi yang Anda miliki).

--name string

    Nama aplikasi yang akan diimpor. Jika tidak ditentukan, mencantumkan semua aplikasi untuk pilihan interaktif.

--output-dir string

    Direktori untuk menghasilkan bundel. Default ke nama aplikasi.

-q, --quiet

    Sembunyikan pesan informasi (hanya tampilkan kesalahan dan perintah).

Bendera global

Examples

Contoh berikut mengimpor aplikasi, membuat direktori bernama sesuai aplikasi:

databricks apps import --name my-streamlit-app

Contoh berikut mengimpor aplikasi dengan direktori output kustom:

databricks apps import --name my-app --output-dir ~/my-apps/analytics

Contoh berikut mengimpor aplikasi dan membersihkan folder aplikasi lama:

databricks apps import --name my-app --cleanup

daftar aplikasi databricks

Mencantumkan semua aplikasi di ruang kerja.

databricks apps list [flags]

Arguments

None

Opsi

--page-size int

    Batas atas untuk item yang dikembalikan.

--page-token string

    Token paginasi untuk menuju ke halaman berikutnya dari aplikasi.

--space string

    Memfilter aplikasi menurut nama ruang aplikasi.

Bendera global

Examples

Contoh berikut mencantumkan semua aplikasi:

databricks apps list

Contoh berikut mencantumkan aplikasi dengan ukuran halaman tertentu:

databricks apps list --page-size 10

Contoh berikut mencantumkan aplikasi dengan paginasi:

databricks apps list --page-token "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

daftar penyebaran aplikasi Databricks

Cantumkan semua penerapan aplikasi untuk aplikasi dengan nama yang diberikan.

databricks apps list-deployments APP_NAME [flags]

Arguments

APP_NAME

    Nama aplikasi.

Opsi

--page-size int

    Batas atas untuk item yang dikembalikan.

--page-token string

    Token paginasi untuk menuju ke halaman berikutnya dari aplikasi.

Bendera global

Examples

Contoh berikut mencantumkan semua deployment untuk sebuah aplikasi:

databricks apps list-deployments my-analytics-app

Contoh berikut mencantumkan penyebaran dengan ukuran halaman tertentu:

databricks apps list-deployments my-data-app --page-size 10

log aplikasi databricks

Streaming log stdout/stderr untuk aplikasi Databricks menggunakan aliran lognya. Secara default, perintah ini mengambil log terbaru hingga --tail-lines dan keluar. Pemfilteran sisi server tersedia menggunakan --search dan pemfilteran sisi klien tersedia menggunakan --source APP|SYSTEM.

databricks apps logs [NAME] [flags]

Arguments

NAME

    Nama aplikasi.

Opsi

-f, --follow

    Lanjutkan log streaming hingga dibatalkan atau batas waktu tertentu tercapai.

--tail-lines int

    Jumlah baris log terbaru yang ditampilkan sebelum streaming. Atur ke 0 untuk menampilkan semuanya. Standar: 200

--timeout duration

    Waktu maksimum untuk melakukan streaming saat --follow diatur. Atur ke 0 untuk menonaktifkan batas waktu.

--search string

    Kirim istilah pencarian ke layanan log sebelum streaming.

--source strings

    Batasi log pada sumber APP atau SYSTEM.

--output-file string

    Jalur file opsional untuk menulis log selain stdout.

Bendera global

Examples

Contoh berikut mengambil log terbaru untuk aplikasi:

databricks apps logs my-analytics-app

Contoh berikut menampilkan log terus menerus hingga dihentikan.

databricks apps logs my-analytics-app --follow

Contoh berikut mengambil 500 baris log terakhir:

databricks apps logs my-data-app --tail-lines 500

Contoh berikut mengalirkan log dengan batas waktu 10 menit:

databricks apps logs my-ml-app --follow --timeout 10m

Contoh berikut memfilter log menurut istilah pencarian:

databricks apps logs my-analytics-app --search "error"

Contoh berikut membatasi log hanya untuk output tingkat aplikasi:

databricks apps logs my-data-app --source APP

Contoh berikut menulis log ke stdout dan file:

databricks apps logs my-ml-app --output-file /tmp/app-logs.txt

aplikasi databricks run-local

Mulai aplikasi secara lokal.

databricks apps run-local [flags]

Arguments

None

Opsi

--app-port int

    Port tempat menjalankan aplikasi (default 8000).

--debug

    Aktifkan mode debug.

--debug-port string

    Port di mana debugger dijalankan.

--entry-point string

    Tentukan titik entri kustom dengan konfigurasi (file .yml) untuk aplikasi. Secara default menjadi app.yml.

--env strings

    Atur variabel lingkungan.

--port int

    Port tempat menjalankan proksi aplikasi (default 8001).

--prepare-environment

    Menyiapkan lingkungan untuk menjalankan aplikasi. Memerlukan uv untuk diinstal.

Bendera global

Examples

Contoh berikut menjalankan aplikasi secara lokal dengan pengaturan default:

databricks apps run-local

Contoh berikut menjalankan aplikasi secara lokal pada port tertentu:

databricks apps run-local --app-port 9000 --port 9001

aplikasi databricks dijalankan

Mulai penyebaran aplikasi aktif terakhir di ruang kerja.

databricks apps start [NAME] [flags]

Arguments

NAME

    Nama aplikasi.

Opsi

--no-wait

    Jangan menunggu untuk mencapai status ACTIVE.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status ACTIVE (default 20m0s).

Bendera global

Examples

Contoh berikut memulai aplikasi:

databricks apps start my-analytics-app

Contoh berikut memulai aplikasi tanpa menunggu:

databricks apps start my-data-app --no-wait

Contoh berikut memulai aplikasi dengan batas waktu kustom:

databricks apps start my-ml-app --timeout 30m

aplikasi databricks berhenti

Hentikan penyebaran aktif aplikasi di ruang kerja.

databricks apps stop [NAME] [flags]

Arguments

NAME

    Nama aplikasi.

Opsi

--no-wait

    Jangan menunggu untuk mencapai status BERHENTI.

--timeout duration

    Jumlah waktu maksimum untuk mencapai status STOP (default 20m0s).

Bendera global

Examples

Contoh berikut menghentikan aplikasi:

databricks apps stop my-analytics-app

Contoh berikut menghentikan aplikasi tanpa menunggu:

databricks apps stop my-data-app --no-wait

Contoh berikut menghentikan aplikasi dengan batas waktu kustom:

databricks apps stop my-ml-app --timeout 30m

pembaruan aplikasi databricks

Perbarui aplikasi dengan nama yang disediakan.

databricks apps update NAME [flags]

Arguments

NAME

    Nama aplikasi. Nama hanya boleh berisi karakter alfanumerik huruf kecil dan tanda hubung. Ini harus unik dalam ruang kerja.

Opsi

--budget-policy-id string

    ID kebijakan anggaran untuk aplikasi.

--compute-size ComputeSize

    Ukuran komputasi untuk aplikasi. Nilai yang didukung: LARGE, MEDIUM.

--description string

    Deskripsi aplikasi.

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

--space string

    Nama ruang tempat aplikasi ini berada.

--usage-policy-id string

    ID kebijakan penggunaan untuk aplikasi.

Bendera global

Examples

Contoh berikut memperbarui deskripsi aplikasi:

databricks apps update my-analytics-app --description "Updated analytics dashboard"

aplikasi databricks dapatkan-tingkat-izin

Memperoleh tingkat izin aplikasi.

databricks apps get-permission-levels APP_NAME [flags]

Arguments

APP_NAME

    Aplikasi untuk mendapatkan atau mengelola izin.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan level izin untuk sebuah aplikasi:

databricks apps get-permission-levels my-analytics-app

dapatkan izin aplikasi databricks

Mendapatkan hak akses aplikasi. Aplikasi dapat mewarisi izin dari objek akarnya.

databricks apps get-permissions APP_NAME [flags]

Arguments

APP_NAME

    Aplikasi untuk mendapatkan atau mengelola izin.

Opsi

Bendera global

Examples

Contoh berikut mendapatkan izin untuk aplikasi:

databricks apps get-permissions my-analytics-app

Contoh berikut mendapatkan izin menggunakan profil tertentu:

databricks apps get-permissions my-ml-app --profile production

mengatur izin aplikasi Databricks

Atur izin aplikasi.

Mengatur izin pada objek, menggantikan izin yang ada jika ada. Menghapus semua izin langsung jika tidak ada yang ditentukan. Objek dapat mewarisi izin dari objek akarnya.

databricks apps set-permissions APP_NAME [flags]

Arguments

APP_NAME

    Aplikasi untuk mendapatkan atau mengelola izin.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

Examples

Contoh berikut menetapkan izin menggunakan konfigurasi JSON:

databricks apps set-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_USE"}]}'

pembaruan izin aplikasi Databricks

Perbarui izin di aplikasi. Aplikasi dapat mewarisi izin dari objek akarnya.

databricks apps update-permissions APP_NAME [flags]

Arguments

APP_NAME

    Aplikasi untuk mendapatkan atau mengelola izin.

Opsi

--json JSON

    String JSON sebaris atau @path ke file JSON dengan isi permintaan.

Bendera global

Examples

Contoh berikut memperbarui izin menggunakan konfigurasi JSON:

databricks apps update-permissions my-analytics-app --json '{"access_control_list": [{"user_name": "someone@example.com", "permission_level": "CAN_MANAGE"}]}'

Bendera dunia

--debug

  Apakah akan mengaktifkan pengelogan debug.

-h atau --help

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

--log-file tali

    String yang mewakili file 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 yang ~/.databrickscfg akan 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