Penggunaan dasar untuk 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.

Halaman ini memperlihatkan kepada Anda cara mencantumkan grup perintah dan perintah Databricks CLI, menampilkan bantuan Databricks CLI, dan bekerja dengan output Databricks CLI. Lihat Apa itu Databricks CLI?.

Untuk menginstal dan mengonfigurasi autentikasi untuk Databricks CLI, lihat Tutorial Databricks CLI.

Mencantumkan perintah CLI yang tersedia

Untuk mencantumkan grup perintah CLI yang tersedia, gunakan opsi --help atau -h, misalnya:

databricks -h

Untuk mencantumkan perintah untuk grup perintah apa pun, gunakan --help opsi atau -h . Misalnya, untuk mencantumkan clusters perintah:

databricks clusters -h

Tampilkan bantuan perintah CLI

Untuk menampilkan informasi penggunaan untuk perintah, gunakan opsi --help atau -h dengan perintah. Misalnya, untuk menampilkan bantuan untuk clusters list perintah:

databricks clusters list -h

Referensi perintah juga tersedia. Lihat perintah Databricks CLI.

Menjalankan perintah

Informasi penggunaan lengkap dan sintaks untuk perintah individual dapat ditemukan dalam bantuan dan referensi baris perintah, tetapi perintah Databricks CLI umumnya sesuai dengan sintaks berikut:

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

Tidak setiap perintah memiliki sub-perintah tambahan. Bendera global tersedia, dan beberapa perintah memiliki bendera tambahan. Misalnya, perintah berikut menghasilkan kluster yang tersedia, menggunakan bendera khusus perintah:

databricks clusters list --can-use-client JOBS

Tip

Anda dapat menjalankan perintah Databricks CLI dari dalam ruang kerja Databricks menggunakan terminal web. Terminal web ruang kerja dapat digunakan oleh banyak pengguna pada satu komputasi dan tidak mengharuskan Anda untuk mengonfigurasi autentikasi. Lihat Menjalankan perintah shell di terminal web Azure Databricks.

Input dan output JSON

Beberapa perintah Databricks CLI memiliki --json bendera atau opsi lain yang menerima input string JSON. Selain itu, beberapa perintah menghasilkan string JSON.

Pemformatan string

Format string JSON tergantung pada sistem operasi Anda:

Linux atau macOS

Sertakan parameter string JSON dalam tanda kutip ganda dan sertakan seluruh payload JSON dalam tanda kutip tunggal. Contohnya:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

Sertakan parameter string JSON dan seluruh payload JSON dalam tanda kutip ganda, dan mendahului karakter kuotasi ganda di dalam payload JSON dengan garis miring terbalik (\). Contohnya:

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Mengatur bidang dalam string JSON

Bendera --json pada banyak perintah memungkinkan Anda mengatur bidang objek yang mungkin tidak tersedia sebagai perintah atau opsi CLI. Misalnya, panggilan berikut menambahkan pengguna dengan ID 9ddddddd-1eee-4eee-a666-8fff7c111111 ke grup dengan ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux atau macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

Memfilter output JSON dengan jq

Untuk perintah Databricks CLI yang menghasilkan JSON, Anda dapat menggunakan prosesor baris perintah jq untuk memfilter output. Misalnya, untuk mencantumkan hanya nama tampilan kluster Azure Databricks dengan ID kluster yang ditentukan:

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

My-11.3-LTS-Cluster

Anda dapat menginstal jq di macOS menggunakan Homebrew dengan brew install jq atau di Windows menggunakan Chocolatey dengan choco install jq. Untuk informasi lebih lanjut tentang jq, lihat Manual jq.

Konfigurasi server proksi

Untuk merutekan permintaan dan respons CLI Databricks melalui server proksi, atur HTTPS_PROXY variabel lingkungan pada komputer tempat CLI Databricks diinstal ke URL server proksi.

Untuk mengatur variabel lingkungan, lihat dokumentasi sistem operasi Anda.