Driver Databricks untuk SQLTools untuk Visual Studio Code

Penting

Fitur ini ada di Pratinjau Publik.

Driver Databricks untuk SQLTools memungkinkan Anda menggunakan ekstensi SQLTools untuk Visual Studio Code untuk menelusuri objek SQL dan menjalankan kueri SQL di ruang kerja Azure Databricks jarak jauh.

Requirements

Sebelum Anda dapat menggunakan Driver Databricks untuk SQLTools, ruang kerja Azure Databricks dan mesin pengembangan lokal Anda harus memenuhi persyaratan berikut.

Persyaratan ruang kerja

Anda harus memiliki setidaknya satu ruang kerja Azure Databricks yang tersedia, dan ruang kerja harus memenuhi persyaratan berikut:

  • Ruang kerja harus berisi setidaknya satu Databricks SQL warehouse.

    Catatan

    Kluster Azure Databricks kluster tidak didukung oleh Driver Databricks untuk SQLTools.

  • Untuk ruang kerja yang diaktifkan untuk Unity Catalog, ruang kerja harus berisi setidaknya satu katalog, dengan setidaknya satu skema (secara resmi disebut database) dalam katalog tersebut.

  • Untuk ruang kerja yang tidak diaktifkan untuk Unity Catalog, ruang kerja harus berisi setidaknya satu skema (sebelumnya disebut database).

Persyaratan komputer pengembangan lokal

Anda harus memiliki hal berikut di komputer pengembangan lokal Anda:

  • Visual Studio Code versi 1.70 atau yang lebih tinggi. Untuk melihat versi yang diinstal, klik Code > Tentang Visual Studio Code dari menu utama di Linux atau macOS dan Bantuan > Tentang di Windows. Untuk mengunduh, menginstal, dan mengonfigurasi Visual Studio Code, lihat Menyiapkan Visual Studio Code.
  • Ekstensi SQLTools untuk Visual Studio Code.
  • Ekstensi Driver Databricks untuk SQLTools untuk Visual Studio Code.

Untuk menginstal ekstensi SQLTools, buka SQLTools lalu klik Instal, atau:

  1. Di Visual Studio Code, klik View > Ekstensi di menu utama.

  2. Dalam kotak Ekstensi Pencarian di Marketplace , masukkan SQLTools.

  3. Klik entri SQLTools dari Matheus Teixeira.

    Catatan

    Mungkin ada beberapa entri SQLTools yang tercantum. Pastikan untuk mengklik entri dari Matheus Teixeira.

  4. Klik Pasang.

Untuk menginstal ekstensi Databricks Driver for SQLTools, buka Databricks Driver for SQLTools lalu klik Instal, atau:

  1. Di Visual Studio Code, klik Tampilkan > Ekstensi di menu utama.
  2. Dalam kotak Ekstensi Pencarian di Marketplace , masukkan Databricks Driver for SQLTools.
  3. Klik entri Driver Databricks untuk SQLTools.
  4. Klik Pasang.

Autentikasi

Anda harus menyiapkan autentikasi untuk Driver Databricks untuk SQLTools sebagai berikut.

Driver Databricks untuk SQLTools mendukung jenis autentikasi Azure Databricks berikut:

Catatan

Driver Databricks untuk SQLTools tidak mendukung token ID Microsoft Entra.

Autentikasi token akses pribadi Azure Databricks

Untuk menggunakan Driver Databricks untuk SQLTools dengan autentikasi token akses pribadi Azure Databricks, Anda harus memiliki token akses pribadi Azure Databricks. Untuk membuat token akses pribadi, ikuti langkah-langkah dalam Membuat token akses pribadi untuk pengguna ruang kerja.

Autentikasi mesin-ke-mesin (M2M) Azure Databricks OAuth

Anda dapat menggunakan Azure Databricks autentikasi OAuth machine-to-machine (M2M) untuk mengautentikasi dengan Driver Databricks untuk SQLTools, sebagai berikut:

Catatan

Autentikasi Azure Databricks OAuth M2M tersedia di Driver Databricks untuk SQLTools versi 0.4.2 ke atas.

  1. Selesaikan langkah-langkah konfigurasi untuk autentikasi M2M OAuth. Lihat Autentikasi OAuth mesin-ke-mesin (M2M).
  2. Buat profil konfigurasi Azure Databricks dengan pengaturan konfigurasi autentikasi M2M OAuth Anda. Lihat bagian "Config" dari autentikasi OAuth mesin-ke-mesin (M2M).
  3. Instal dan buka ekstensi Databricks untuk Visual Studio Code di komputer pengembangan lokal Anda.
  4. Di ekstensi Databricks IDE, klik tombol Configure di panel Konfigurasi. Jika tombol Konfigurasi tidak ditampilkan, klik ikon roda gigi (Konfigurasi ruang kerja) sebagai gantinya.
  5. Di Palet Perintah, untuk Host Databricks, masukkan URL per ruang kerja Azure Databricks Anda, misalnya https://adb-1234567890123456.7.azuredatabricks.net, lalu tekan Enter.
  6. Pilih entri profil konfigurasi yang cocok dengan yang Anda buat di langkah 2.
  7. Selesaikan instruksi di layar di browser web Anda untuk menyelesaikan autentikasi dengan akun Azure Databricks Anda.

Autentikasi OAuth Azure Databricks pengguna-ke-mesin (U2M)

Anda dapat menggunakan autentikasi OAuth user-to-machine (U2M) Azure Databricks untuk mengautentikasi dengan Driver Databricks untuk SQLTools, sebagai berikut:

Catatan

Autentikasi Azure Databricks OAuth U2M tersedia di Driver Databricks untuk SQLTools versi 0.4.2 ke atas.

  1. Instal dan buka ekstensi Databricks untuk Visual Studio Code di komputer pengembangan lokal Anda.
  2. Di ekstensi Databricks IDE, klik tombol Configure di panel Konfigurasi. Jika tombol Konfigurasi tidak ditampilkan, klik ikon roda gigi (Konfigurasi ruang kerja) sebagai gantinya.
  3. Di Command Palette, untuk Databricks Host, masukkan URL per ruang kerja Azure Databricks Anda, misalnya . Lalu tekan Enter.
  4. Pilih OAuth (pengguna ke mesin).
  5. Selesaikan instruksi di layar di browser web Anda untuk menyelesaikan autentikasi dengan akun Azure Databricks Anda. Jika diminta, izinkan akses all-apis.

Autentikasi Azure CLI

Anda dapat menggunakan Azure CLI untuk mengautentikasi dengan Driver Databricks untuk SQLTools, sebagai berikut:

Catatan

Mengautentikasi dengan Azure CLI berada dalam status fitur Eksperimental . Fitur ini tersedia di Driver Databricks untuk SQLTools versi 0.4.2 ke atas.

  1. Instal Azure CLI di komputer pengembangan lokal Anda, jika Anda belum melakukannya.
  2. Instal dan buka ekstensi Databricks untuk Visual Studio Code di komputer pengembangan lokal Anda.
  3. Di ekstensi Databricks IDE, klik tombol Configure di panel Konfigurasi. Jika tombol Konfigurasi tidak ditampilkan, klik ikon roda gigi (Konfigurasikan ruang kerja) sebagai gantinya.
  4. Di Command Palette, untuk Databricks Host, masukkan URL per-workspace Azure Databricks Anda, misalnya . Lalu tekan Enter.
  5. Pilih Azure CLI.
  6. Ikuti perintah di layar untuk menyelesaikan autentikasi dengan Azure CLI.

Menyambungkan ke skema

  1. Di Visual Studio Code, pada bar samping, klik ikon SQLTools.

  2. Dalam tampilan SQLTools, jika ini pertama kalinya Anda menggunakan ekstensi SQLTools, klik Tambahkan Koneksi Baru di dalam panel Koneksi. Jika tidak, klik ikon Tambahkan Koneksi Baru di bilah judul panel.

  3. Pada tab Pengaturan SQLTools, untuk langkah Pilih driver database, klik ikon Databricks.

  4. Untuk langkah Pengaturan Koneksi , masukkan informasi berikut tentang gudang, katalog, dan skema Anda:

    1. Untuk Nama koneksi, masukkan beberapa nama unik untuk koneksi ini.
    2. (Opsional) Untuk Grup koneksi masukkan nama grup koneksi yang sudah ada untuk menambahkan koneksi baru ke grup tersebut. Atau, masukkan nama unik untuk membuat grup koneksi baru yang berisi koneksi baru ini. Grup koneksi memudahkan untuk menemukan koneksi di ekstensi.
    1. Untuk Sambungkan menggunakan, pilih salah satu berikut:
      • Untuk menggunakan token akses pribadi Azure Databricks untuk autentikasi, pilih Nama Host dan Token.
      • Untuk Driver Databricks untuk SQLTools versi 0.4.2 ke atas, untuk menggunakan otentikasi OAuth U2M atau M2M atau Azure CLI, pilih ekstensi Visual Studio Code (beta).

    1. Jika Anda memilih Nama Host dan Token untuk Sambungkan menggunakan, maka untuk Host, masukkan pengaturan Nama host Server gudang. Untuk mendapatkan pengaturan nama host Server gudang, lihat Mendapatkan detail koneksi untuk sumber daya komputasi Azure Databricks.

    2. Untuk Jalur, masukkan pengaturan jalur HTTP gudang atau kluster. Untuk mendapatkan pengaturan jalur HTTP gudang, lihat Mendapatkan detail koneksi untuk sumber daya komputasi Azure Databricks.

    3. Jika Anda memilih Nama Host dan Token untuk Menyambungkan menggunakan, masukkan nilai token akses pribadi Azure Databricks Anda di Token.

    4. Untuk Katalog, masukkan nama katalog Anda.

      Catatan

      Untuk ruang kerja yang tidak diaktifkan untuk Katalog Unity, Anda dapat membiarkan Katalog kosong untuk menggunakan nilai hive_metastoredefault .

    5. Untuk Skema, masukkan nama skema Anda.

    6. (Opsional) Untuk Tampilkan batas default rekaman, biarkan nilai default 50 untuk hanya menampilkan hingga 50 baris pertama untuk setiap kueri, atau masukkan batas yang berbeda.

  5. Klik Uji Koneksi.

  6. Jika pengujian koneksi berhasil, klik Simpan Koneksi.

Mengubah pengaturan koneksi

Prosedur ini mengasumsikan bahwa Anda telah berhasil terhubung ke setidaknya satu gudang.

  1. Jika tampilan SQLTools tidak terlihat, maka di Visual Studio Code, di bar samping, klik ikon SQLTools.
  2. Di panel Koneksi , perluas grup koneksi, jika ada untuk koneksi target Anda.
  3. Klik kanan koneksi, dan klik Edit Connection.
  4. Ubah pengaturan target.
  5. Klik Uji Koneksi.
  6. Jika pengujian koneksi berhasil, klik Simpan Koneksi.

Menelusuri objek skema

  1. Di panel Koneksi , perluas grup koneksi, jika ada untuk koneksi target Anda.
  2. Klik dua kali atau perluas koneksi tujuan milik gudang Anda.
  3. Perluas database target (skema), jika ada untuk koneksi Anda.
  4. Perluas Tabel atau Tampilan, jika ada satu atau beberapa tabel atau tampilan untuk database (skema) Anda.
  5. Perluas tabel atau pandangan target apa pun agar dapat melihat kolom tabel atau pandangan tersebut.

Menampilkan baris atau skema untuk tabel atau tampilan

Dengan Tabel atau Tampilan diperluas di panel Koneksi , lakukan salah satu hal berikut ini:

  • Untuk memperlihatkan baris tabel atau tampilan, klik kanan tabel atau tampilan, dan klik Perlihatkan Rekaman Tabel atau Perlihatkan Rekaman Tampilan.
  • Untuk memperlihatkan skema tabel atau tampilan, klik kanan tabel atau tampilan, dan klik Jelaskan Tabel atau Jelaskan Tampilan.

Membuat kueri sisipkan untuk tabel

  1. Tempatkan kursor Anda di editor yang sudah ada di lokasi tempat Anda ingin kueri insert ditambahkan.
  2. Dengan panel Koneksi diperluas pada Tabel, klik kanan tabel, lalu klik Hasilkan Kueri INSERT. Definisi kueri penyisipan ditambahkan pada titik penyisipan kursor.

Buat dan jalankan kueri

Prosedur ini mengasumsikan bahwa Anda telah berhasil terhubung ke setidaknya satu gudang.

  1. Di panel Koneksi , perluas grup koneksi, jika ada untuk koneksi target Anda.
  2. Klik dua kali atau perluas koneksi target pada gudang Anda.
  3. Dengan koneksi dipilih, klik File SQL Baru di bilah judul panel Koneksi . Tab editor baru muncul.
  4. Masukkan kueri SQL Anda di editor baru.
  5. Untuk menjalankan kueri SQL, klik Jalankan pada koneksi aktif di editor. Hasil kueri ditampilkan di tab editor baru.

Menjalankan kueri yang sudah ada

Prosedur ini mengasumsikan bahwa Anda telah berhasil terhubung ke setidaknya satu gudang.

  1. Di panel Koneksi , perluas grup koneksi, jika ada untuk koneksi target Anda.
  2. Klik dua kali atau perluas koneksi target gudang Anda.
  3. Dengan koneksi yang dipilih, buka file apa pun dengan ekstensi file .sql, atau pilih grup pernyataan SQL berkelanjutan apa pun di editor apa pun yang sebelumnya dibuka.
  4. Untuk menjalankan kueri SQL dari file yang terbuka .sql , dengan konten file Anda .sql ditampilkan di editor, klik Jalankan pada koneksi aktif di editor. Hasil kueri ditampilkan di tab editor baru.
  5. Untuk menjalankan grup pernyataan SQL berkelanjutan yang dipilih di editor yang sebelumnya dibuka, klik kanan pilihan Anda, lalu klik Jalankan Kueri yang Dipilih. Hasil kueri ditampilkan di tab editor baru.

Mengirim log penggunaan ke Databricks

Jika Anda mengalami masalah saat menggunakan Driver Databricks untuk SQLTools, Anda dapat mengirim log penggunaan dan informasi terkait ke Dukungan Databricks dengan melakukan hal berikut:

  1. Instal ekstensi Databricks untuk Visual Studio Code di komputer pengembangan lokal Anda.
  2. Aktifkan pencatatan dengan mencentang pengaturan Logs: Enabled, atau pengaturan databricks.logs.enabled ke true, seperti yang dijelaskan dalam Pengaturan untuk ekstensi IDE Databricks Pastikan untuk memulai ulang Visual Studio Code setelah Anda mengaktifkan logging.
  3. Cobalah untuk mereprodusi masalah Anda.
  4. Dari Palet Perintah (Tampilan > Palet Perintah dari menu utama), jalankan perintah Databricks: Buka log lengkap.
  5. Kirim file Databricks Logs.log, databricks-cli-logs.json, dan sdk-and-extension-logs.json yang ditampilkan ke Dukungan Databricks.
  6. Salin juga konten Terminal (Lihat > Terminal) dalam konteks masalah, dan kirim konten ini ke Dukungan Databricks.

Tampilan Output (Lihat > Output, Log Databricks) menampilkan informasi yang terpotong jika Logs: Enabled dicentang atau diatur ke . Untuk menampilkan informasi lebih lanjut, ubah pengaturan berikut, seperti yang dijelaskan dalam Pengaturan untuk ekstensi Databricks IDE:

  • Log: Panjang Maksimum Array atau databricks.logs.maxArrayLength
  • Logs: Panjang Maksimum Bidang atau databricks.logs.maxFieldLength
  • Log: Kedalaman Pemendekan atau databricks.logs.truncationDepth

Sumber Daya Tambahan

  • Terakhir diperbarui pada