Bekerja dengan widget parameter

Saat Anda menambahkan penanda parameter bernama ke kueri, Azure Databricks menampilkan widget parameter di UI. Widget memungkinkan pengguna mengatur nilai parameter tanpa mengedit kueri secara langsung. Anda dapat mengonfigurasi jenis, judul, dan nilai default setiap widget.

Parameter widget didukung di editor SQL, notebook, dasbor AI/BI, dan Genie Spaces, tetapi berperilaku berbeda pada setiap platform ini. Halaman ini menjelaskan widget parameter di editor SQL. Untuk permukaan lain, lihat:

Di editor SQL, jenis parameter apa pun (String, Bilangan Bulat, Desimal, Tanggal, Tanda Waktu) dapat menggunakan jenis widget apa pun.

Mengonfigurasi widget parameter

  1. Tambahkan penanda parameter bernama ke kueri Anda. Widget muncul di UI.
  2. Klik ikon gigi di samping widget untuk membuka dialog widget. dialog buat widget
  3. Atur bidang berikut:
    • Nama parameter: Nama parameter seperti yang muncul dalam kueri. Jika Anda mengubah nama parameter, dalam dialog widget, Anda juga harus mengubahnya dalam kueri.
    • Label widget: String yang menjelaskan widget
    • Jenis widget: Mengontrol cara pengguna memasukkan nilai. Lihat Jenis widget di bawah ini.
    • Jenis parameter: Jenis data parameter. Lihat Jenis parameter.
  4. Klik menjauh dari dialog widget untuk menyimpan perubahan Anda.

Mengedit, menghapus, dan menyusun ulang widget

Edit: Klik ikon gerigi di samping widget untuk membuka kembali panel pengaturan.

Hapus: Hapus penanda parameter dari kueri. Widget dihapus secara otomatis.

Urutkan ulang: Gunakan handel seret ke sebelah kiri widget untuk menyusun ulang.

Jenis widget

Azure Databricks mendukung jenis widget berikut untuk parameter kueri:

Jenis widget Deskripsi
Dropdown Pengguna harus memilih dari daftar yang telah ditentukan sebelumnya.
Combobox Pengguna dapat memilih dari daftar yang telah ditentukan sebelumnya atau mengetikkan nilai kustom.
Input teks Menerima nilai bentuk bebas tanpa saran.
Pilihan Ganda Pengguna dapat memilih lebih dari satu nilai dari daftar yang telah ditentukan sebelumnya.
Dropdown dinamis Mengisi pilihan dari kueri yang disimpan alih-alih daftar statis.
Rentang Tanggal dan Tanda Waktu Menentukan rentang awal dan akhir menggunakan .min parameter dan .max .

Masukan Teks

Menerima nilai bentuk bebas langsung dari pengguna. Gunakan widget ini ketika tidak ada opsi yang telah ditentukan sebelumnya yang diperlukan.

SELECT * FROM samples.tpch.region WHERE r_name = :region_param

Menyajikan daftar nilai yang telah ditentukan sebelumnya. Pengguna harus memilih dari daftar — entri bentuk bebas tidak diizinkan. Masukkan nilai yang diizinkan di panel pengaturan, satu per baris.

SELECT * FROM samples.tpch.orders WHERE o_orderstatus = :status_param

Untuk membuat jenis widget dropdown:

  1. Klik ikon roda gigi di sebelah :status_param widget.
  2. Atur Jenis widget menjadi Daftar Pilihan (Dropdown).
  3. Atur Jenis Parameter menjadi String.
  4. Masukkan nilai ke dalam bidang teks Pilihan untuk nilai parameter. Klik Tambahkan atau tekan enter di antara setiap nilai.

Kotak kombo

Menyajikan daftar nilai yang disarankan sebelumnya tetapi juga memungkinkan pengguna untuk mengetik nilai kustom yang tidak ada dalam daftar. Gunakan kotak kombo saat opsi umum berguna untuk kenyamanan tetapi Anda ingin mengizinkan input bentuk bebas.

SELECT * FROM samples.tpch.part WHERE p_brand = :brand_param

Pilihan Ganda

Memungkinkan pengguna memilih lebih dari satu nilai dari daftar yang telah ditentukan sebelumnya. Nilai yang dipilih diteruskan ke kueri sebagai koleksi.

SELECT * FROM samples.nyctaxi.trips WHERE
  array_contains(
    TRANSFORM(SPLIT(:list_parameter, ','), s -> TRIM(s)),
    CAST(dropoff_zip AS STRING)
  )

Untuk menambahkan opsi untuk menu tarik-turun multipilih:

  1. Klik ikon roda gigi di sebelah list_parameter widget.
  2. Atur Jenis widget menjadi Multipilih.
  3. Atur Jenis Parameter menjadi String.
  4. Masukkan nilai ke dalam bidang teks Pilihan untuk nilai parameter. Klik Tambahkan atau tekan enter di antara setiap nilai.

Dropdown dinamis

Nota

Widget dropdown dinamis hanya tersedia di editor SQL, bukan di notebook.

Mengisi daftar pilihan dari kueri yang disimpan alih-alih daftar statis. Saat data yang mendasar berubah, opsi yang tersedia diperbarui secara otomatis.

Untuk menggunakan dropdown dinamis:

  1. Buat dan simpan kueri yang mengembalikan nilai yang Anda inginkan di menu dropdown:

    SELECT DISTINCT c_mktsegment FROM samples.tpch.customer ORDER BY c_mktsegment

  2. Di kueri baru atau yang sudah ada, tambahkan penanda parameter bernama:

    SELECT c_custkey, c_name, c_acctbal
FROM samples.tpch.customer
WHERE c_mktsegment = :segment_param

  3. Klik ikon roda gigi di sebelah segment_param widget.

  4. Atur Jenis widget ke Dropdown Dinamis.

  5. Klik bidang Kueri untuk membuka dialog Pilih kueri yang sudah ada . Pilih kueri yang disimpan dari langkah 1, lalu klik Pilih.

  6. Pilih nilai parameter default.

  7. Klik Terapkan perubahan.

Rentang Tanggal dan Tanda Waktu

Parameter Tanggal dan Tanda Waktu mendukung jenis widget Rentang . Saat dipilih, Azure Databricks membuat dua parameter dengan menggunakan akhiran .min dan .max untuk menentukan awal dan akhir rentang.

SELECT * FROM samples.nyctaxi.trips
WHERE tpep_pickup_datetime
BETWEEN CAST(:date_range_min AS TIMESTAMP) AND CAST(:date_range_max AS TIMESTAMP)

Klik ikon petir biru untuk memilih nilai dinamis seperti today, , yesterday, this weeklast week, last month, atau last year. Nilai-nilai ini diperbarui secara otomatis.

Penting

Nilai tanggal dinamis tidak kompatibel dengan kueri terjadwal.

  • Last updated on