Mengedit dan memvalidasi LookML

Menggunakan IDE

Halaman ini menjelaskan beberapa fitur Looker IDE yang dapat membantu Anda menulis LookML.

Anda dapat mengakses Looker IDE ({i>integrated development environment)<i}) melalui menu Develop di Looker. Lihat Mengakses file project untuk mengetahui detail dan opsi lainnya.

Saran otomatis

Saat Anda mengetik, IDE akan menyarankan kemungkinan parameter dan nilai yang sensitif terhadap konteks yang Anda ketik. Misalnya, saran untuk parameter type dimensi hanya akan menyertakan opsi yang valid untuk parameter tersebut. Selain itu, kolom dalam parameter sql harus ditandai dengan ${...} sehingga IDE menambahkan sintaksis tersebut saat menyarankan kolom.

Saran otomatis akan otomatis muncul di mana pun alat tersebut dapat ditampilkan. Untuk menutupnya, tekan tombol Esc pada keyboard. Untuk melihatnya kapan saja, tekan Ctrl+Space (Windows) atau Control-Space (Mac).

Pemeriksaan error ad hoc

IDE mendeteksi error sintaksis saat Anda mengetik. Tanda X merah di {i>gutter<i} menunjukkan kesalahan sintaksis, yang digarisbawahi dengan warna merah. Saat Anda mengarahkan kursor ke tanda X merah, deskripsi singkat tentang masalah akan muncul. Misalnya, jika Anda salah mengetik avrage dan bukan average sebagai nilai parameter type untuk ukuran, IDE akan menampilkan error Invalid value for "type":avrage.

Validator LookML masih diperlukan untuk melakukan validasi model lengkap. Beberapa error, seperti referensi kolom yang tidak valid karena penggabungan yang tidak ada, memerlukan tinjauan menyeluruh pada model, sehingga hanya ditampilkan saat Validator LookML dijalankan.

Panel Bantuan Cepat

Pilih ikon Bantuan Cepat untuk membuka panel Bantuan Cepat yang berisi penjelasan dan opsi untuk lokasi saat ini dalam kode. Pilih nama parameter di sidebar untuk membuka halaman dokumentasi Looker untuk parameter tersebut.

Catatan: Anda juga dapat menggunakan panel metadata untuk melihat informasi yang relevan secara kontekstual tentang objek di panel metadata Looker IDE. Lihat halaman dokumentasi Metadata untuk objek LookML untuk mengetahui informasi selengkapnya.

Pemformatan otomatis

Saat berada dalam Mode Pengembangan, Anda dapat menggunakan pintasan keyboard file format untuk membuat indentasi file LookML secara otomatis. Indentasi menunjukkan hierarki parameter dan subparameter, membuat LookML Anda lebih mudah dibaca dan dipahami.

Lipat

Panah kecil muncul di gutter di samping awal setiap parameter LookML tingkat atas dalam file. Memilih panah ini akan melipat atau membuka bagian LookML sehingga Anda dapat fokus hanya pada bagian tertentu.

Menu See file actions untuk file LookML juga menyediakan opsi Fold LookML dan Unfold LookML untuk meluaskan atau menciutkan semua bagian LookML hingga ke parameter tingkat atas dalam file saat ini.

Anda juga dapat menggunakan pintasan keyboard untuk melipat dan membentangkan LookML.

Menandai penambahan, perubahan, dan penghapusan

Di LookML IDE, beberapa indikator selalu ditampilkan saat Anda berada dalam Development Mode dan memiliki perubahan yang tidak di-commit.

• Nama file akan ditampilkan dengan titik biru di sisi kiri jendela untuk menunjukkan bahwa file tersebut baru, diubah, atau diganti namanya.
• Saat Anda membuka file baru atau yang diubah, nomor baris di dalam file akan ditandai dengan warna hijau untuk menampilkan baris baru atau yang diubah, dan garis merah horizontal menunjukkan baris yang dihapus.

Menambahkan komentar

Anda dapat menambahkan komentar ke LookML agar lebih mudah dibaca. Untuk menambahkan satu komentar, gunakan karakter #:

dimension: name {
  sql: ${TABLE}.name ;; # This is the customer's full name
}

Anda dapat menjadikan seluruh blok kode sebagai komentar menggunakan pintasan keyboard dengan melakukan langkah-langkah berikut:

1. Pilih baris yang ingin Anda komentari.
2. Tekan Command + / (Mac) atau Ctrl + / (Windows).

IDE akan menambahkan karakter # ke setiap baris yang Anda pilih.

Memberikan komentar pada blok SQL

Jika Anda menjadikan baris sebagai komentar yang sepenuhnya berada dalam blok kode SQL, tambahkan notasi komentar SQL secara manual.

Saat Anda menggunakan blok komentar SQL, bagian yang diberi komentar masih akan ditafsirkan sebagai kode LookML. Oleh karena itu, Anda akan melihat komentar Anda dalam SQL yang dihasilkan LookML, tetapi komentar itu tidak akan mempengaruhi hasil kueri.

Langsung ke objek atau file

Di Looker IDE, Anda dapat melakukan penelusuran cepat untuk langsung membuka objek dan file project LookML menggunakan fitur Jump to object or file. Klik ikon Jump to object or file dari browser file atau browser objek, atau gunakan pintasan keyboard Command-J (Mac) atau Ctrl+J (Windows).

Lihat halaman dokumentasi Mengakses file project LookML untuk informasi selengkapnya.

Menemukan dan mengganti teks dalam project Anda

Looker IDE memiliki fungsi cari dan ganti, yang dapat Anda gunakan untuk menelusuri teks di semua file project, lalu mengganti semua instance atau instance yang dipilih dalam operasi massal.

Tips: Fitur cari dan ganti Looker IDE adalah alat yang efektif untuk menemukan elemen LookML dalam project LookML yang besar dan untuk mengganti teks dalam deskripsi serta label. Jika Anda ingin mencari dan mengganti nama model, Jelajah, dan kolom di project Anda, gunakan fungsi cari dan ganti Validator Konten. Mengubah nama model, Jelajah, dan kolom dapat merusak referensi dalam model Anda, dan Validator Konten dapat memvalidasi referensi LookML serta memperbaiki error di LookML Anda setelah membuat jenis perubahan ini.

Untuk menggunakan fungsi find Looker IDE, ikuti langkah-langkah berikut:

1. Buka panel penelusuran di IDE.
2. Masukkan istilah di kolom Cari.
3. Secara opsional, Anda dapat memilih Case Sensitive untuk menelusuri hanya instance yang cocok dengan huruf besar/kecil yang dimasukkan di kolom Find, atau memilih RegEX untuk melakukan penelusuran ekspresi reguler.
4. Pilih Find.
5. Anda juga dapat memilih nama file untuk membuka file tersebut di IDE.

Jika menggunakan Mode Pengembangan, Anda juga akan melihat kolom Ganti Dengan. Untuk mengganti teks di project Anda, ikuti langkah-langkah berikut:

1. Masukkan teks pengganti di kolom Ganti Dengan. Atau, Anda dapat mengosongkan kolom Ganti Dengan jika ingin menghapus teks di kolom Cari, bukan menggantinya.

2. Pilih Select & Replace untuk melihat pratinjau bagaimana teks akan diganti dalam project Anda.

3. Hasilnya menampilkan semua instance dalam project Anda yang ditandai untuk diganti. Anda dapat menggunakan opsi berikut untuk menyesuaikan instance mana yang diganti:

   • Gunakan kotak centang di samping ringkasan hasil untuk memilih atau membatalkan pilihan semua instance di seluruh project Anda.
   • Gunakan kotak centang di samping sebuah instance untuk memilih atau membatalkan pilihan instance tersebut.

4. Pilih tombol Replace Selected untuk menerapkan penggantian ke instance yang telah Anda pilih. IDE akan menampilkan perubahan yang dibuat.

Membuat dan menguji kolom baru

Sebagai contoh pengeditan LookML, kita akan menambahkan beberapa kolom lalu mengujinya.

Membuat dimensi

Pertama, kita akan menambahkan dimensi baru ke tampilan users yang menentukan apakah pengguna berasal dari California atau New York. Dimensinya akan menjadi type: yesno, yang berarti nilai akan menampilkan Yes jika pengguna berasal dari California atau New York, dan No jika tidak.

LookML untuk dimensi baru terlihat seperti ini:

dimension: from_ca_or_ny {
  type: yesno
  sql: ${TABLE}.state = "California" OR ${TABLE}.state = "New York" ;;
}

Tambahkan dimensi ini ke file tampilan user, lalu klik tombol Save Changes di file.

Lihat operator substitusi untuk mempelajari ${TABLE}.state lebih lanjut.

Membuat ukuran

Selanjutnya, kita akan menambahkan ukuran baru ke tampilan user yang menghitung rata-rata usia pengguna. Ukuran ini akan menjadi type: average dan digabungkan pada kolom age.

LookML untuk ukuran baru ini terlihat seperti ini:

measure: average_age {
  type: average
  sql: ${TABLE}.age ;;
}

Tambahkan ukuran ini ke file tampilan user, lalu klik tombol Save Changes di file.

Menguji kolom di Eksplorasi

Anda dapat menguji dimensi baru dan mengukur dengan membuat kueri untuk dimensi tersebut. Setelah Anda menyimpan perubahan, kolom ini akan muncul di pemilih kolom di bagian Jelajahi. Gunakan menu drop-down Lihat tindakan file di samping nama file tampilan guna mengakses fitur Jelajahi untuk tampilan saat ini dengan mudah. Menu drop-down Lihat tindakan file mencantumkan Jelajah apa pun yang didasarkan pada tampilan, termasuk Jelajah yang menggabungkan tampilan. Misalnya, untuk mengakses Jelajahi untuk tampilan yang disebut users, Anda dapat memilih opsi Jelajahi Pengguna dari menu drop-down Lihat tindakan file.

Di bagian Jelajahi Pengguna, Anda dapat memilih kolom baru untuk menambahkannya ke kueri. Misalnya, Anda dapat membuat kueri dengan kedua kolom baru yang menampilkan usia rata-rata pengguna yang berasal dari California atau New York dan usia rata-rata pengguna yang bukan:

Catatan: Anda harus berada dalam Mode Pengembangan untuk mengakses kolom baru ini sampai Anda melakukan commit dan mengirimkan perubahan ke produksi.

Memvalidasi LookML Anda

Setelah puas dengan pembaruan, Anda dapat menyimpan perubahan. IDE akan memberi tahu Anda jika terdapat error sintaksis yang belum terselesaikan dalam satu file.

Selanjutnya, gunakan Validator LookML untuk melakukan validasi model lengkap. Beberapa error, seperti referensi kolom yang tidak valid karena penggabungan yang tidak ada, memerlukan tinjauan menyeluruh pada model, sehingga hanya ditampilkan saat Validator LookML dijalankan. Pastikan untuk memvalidasi perubahan LookML Anda sebelum memublikasikannya ke lingkungan produksi. Meskipun validasi tidak akan mendeteksi setiap masalah, seperti masalah izin database, sebagian besar error akan dicegah.

Catatan: Validator LookML tidak sama dengan Validator Konten. Validator ini justru memeriksa apakah perubahan yang Anda buat akan merusak Tampilan yang tersimpan.

Validator LookML hanya memindai file LookML yang telah diperbarui sejak validasi LookML terakhir, atau file yang terpengaruh oleh pembaruan:

• Jika setelan tingkat model berubah, semuanya akan divalidasi lagi.
• Jika tampilan berubah, hanya Jelajah tempat tampilan tersebut digunakan yang akan divalidasi lagi.
• Jika Jelajah berubah, hanya Jelajah tersebut yang akan divalidasi lagi.

Tips: Jika Anda melihat bahwa validasi LookML memerlukan waktu lama untuk diselesaikan, hal pertama yang harus diperiksa adalah parameter include di file model Anda. Jika Anda menyertakan semua file tampilan (include: "*.view"), Validator LookML harus memeriksa semuanya, yang dapat memengaruhi performa. Jika demikian, update parameter include file model sehingga hanya file tampilan yang diperlukan yang disertakan.

Menjalankan validasi

Untuk menjalankan Validator LookML, pilih tombol Validasi LookML di kanan atas Looker IDE; atau pilih ikon Project Health di bagian atas IDE untuk membuka panel Project Health, lalu klik ikon Validasi LookML.

Setelah menjalankan Validator LookML, Anda mungkin melihat daftar error dan peringatan lain yang harus diatasi. Anda dapat memilih tanda panah mana saja untuk memperluas daftar error atau peringatan.

Tombol validator di panel Project Health akan tersedia lagi jika Anda melakukan dan menyimpan perubahan lain.

Pesan validasi

Looker menampilkan pesan validasi setelah menjalankan validasi pada LookML Anda.

Catatan: Dasbor LookML menampilkan pesan informasi, bukan peringatan, di sidebar jika pelokalan permisif diaktifkan.

Tidak ditemukan error LookML

Jika tidak ada masalah yang ditemukan oleh validator, Looker akan menampilkan tanda centang hijau bersama dengan teks No LookML errors found.

Error LookML

Error LookML adalah masalah yang dapat mencegah kueri berjalan. Angka dalam tanda kurung adalah jumlah kesalahan yang ditemukan (sembilan dalam contoh berikut):

Dalam daftar masalah yang diperluas, Anda akan melihat alasan validasi tidak lulus. Sering kali, jika mengklik error tersebut, Anda akan langsung diarahkan ke baris kode yang bermasalah. Anda akan melihat tanda "X" merah di samping baris. Mengarahkan kursor ke atasnya akan memberikan informasi error yang lebih mendetail dalam beberapa kasus:

Tips Tim Chat: Error validasi yang paling sering ditanyakan kepada kami adalah "Kolom tidak diketahui atau tidak dapat diakses". Buka halaman Praktik Terbaik Error: Kolom tidak dikenal atau tidak dapat diakses untuk mengetahui penyebabnya dan tindakan yang harus dilakukan.

Peringatan LookML

Peringatan LookML mungkin tidak mencegah kueri dijalankan, tetapi masih dapat mengakibatkan fungsi yang rusak atau tidak diinginkan bagi pengguna Anda. Seperti halnya error, angka dalam tanda kurung adalah jumlah peringatan yang ditemukan (tiga peringatan dalam contoh berikut):

Seperti halnya error LookML, Anda dapat meluaskan peringatan dan langsung ke kode masalah dengan memilih peringatan di panel Project Health, lalu mengarahkan kursor ke ikon X merah untuk melihat informasi selengkapnya:

Men-deploy perubahan Anda

Setelah memvalidasi bahwa perubahan akan berfungsi dengan baik, Anda dapat menggunakan integrasi Git Looker untuk melakukan commit dan men-deploy perubahan ke produksi.

Catatan: Jika Anda mengubah nama kolom yang berfungsi sebagai filter di Tampilan atau dasbor, pastikan untuk meninjau bagian Filter dari Tampilan terjadwal dan dasbor, lalu perbarui filter sesuai kebutuhan untuk menyesuaikan dengan perubahan. Jika pengiriman konten terjadwal menyertakan filter yang tidak lagi berfungsi (misalnya, jika kolom yang direferensikan telah berubah), pengiriman terjadwal dapat menampilkan data yang tidak difilter.