Jenis file dalam project LookML

Project LookML adalah kumpulan file LookML yang memberi tahu Looker cara terhubung ke database Anda, cara membuat kueri data Anda, dan cara mengontrol perilaku antarmuka pengguna. Anda dapat mengakses file project LookML dari bagian Develop di Looker atau dari UI, seperti yang dijelaskan di halaman dokumentasi Mengakses file project LookML.

File project diatur oleh developer Looker Anda menggunakan folder di IDE.

Project LookML terdiri dari minimal satu file model dan minimal satu file tampilan, serta mungkin beberapa jenis file lain yang dijelaskan di halaman ini. Semua file project memiliki ekstensi, meskipun ekstensi tersebut disembunyikan dalam daftar IDE jika project Anda tidak diaktifkan untuk folder di IDE.

Pilih link berikut untuk mendapatkan informasi selengkapnya tentang setiap jenis file yang dapat digunakan dalam project LookML:

Setelah membuat project LookML, Anda dapat mengakses file project dan menambahkan file serta folder baru ke project menggunakan Looker IDE.

File model

File model menentukan koneksi database dan kumpulan Eksplorasi yang menggunakan koneksi tersebut. File model juga menentukan Eksplorasi itu sendiri dan hubungannya dengan tampilan lain. Eksplorasi adalah titik awal untuk membuat kueri data Anda. Dalam istilah SQL, Eksplorasi adalah klausa FROM dari kueri. Eksplorasi yang Anda tentukan dalam model akan dilihat oleh pengguna saat mereka melihat menu Eksplorasi Looker.

Dengan kata lain, file model adalah tempat Anda menentukan tabel data mana yang harus digunakan (sebagai tampilan yang disertakan) dan bagaimana tabel tersebut harus digabungkan, jika perlu.

Perhatikan hal-hal berikut terkait file model:

  • Eksplorasi biasanya ditentukan dalam file model. Namun, terkadang Anda memerlukan file Eksplorasi terpisah untuk tabel turunan, atau untuk memperluas Eksplorasi atau untuk menyempurnakan Eksplorasi di seluruh model.
  • File model harus memiliki nama unik di semua project pada instance Anda. Jika instance Anda berisi dua file .model.lkml dengan nama yang sama, kemungkinan Anda akan mengalami error, seperti error konfigurasi model di halaman Project LookML dan error rendering untuk error dasbor LookML, karena dasbor LookML menggunakan nama model dalam format URL-nya (<hostname>/dashboard/model_name::<dashboard_name>). Anda dapat menggunakan Validator LookML untuk memverifikasi apakah nama model diduplikasi di seluruh instance Anda. Namun, meskipun Validator LookML mendeteksi nama model duplikat di instance Anda, Anda tetap dapat mengirimkan kode ke produksi. Oleh karena itu, pastikan untuk memperbaiki error nama model duplikat sebelum Anda men-deploy project LookML ke produksi.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file model.

Struktur dan sintaksis umum

Dalam tanda kurung kurawal Eksplorasi, { }, Anda menentukan parameter untuk Eksplorasi. Anda dapat menggunakan parameter join untuk menggabungkan tampilan lain ke Eksplorasi dalam file model.

Dalam contoh berikut, LookML dalam file model contoh menentukan Eksplorasi yang disebut inventory_items, beserta tampilan gabungannya:

connection: "thelook_events"

explore: inventory_items {
  join: products {
    type: left_outer
    sql_on: ${inventory_items.product_id} = ${products.id} ;;
    relationship: many_to_one
  }

  join: distribution_centers {
    type: left_outer
    sql_on: ${products.distribution_center_id} = ${distribution_center.id} ;;
    relationship: many_to_one
  }
}

Definisi LookML ini menyebabkan Inventory Items muncul di bagian Explore navigasi Looker dan menggabungkan data dari tampilan products dan distribution_centers ke tampilan inventory_items.

Tampilan Pusat Distribusi, Item Inventaris, dan Produk dapat diakses dari pemilih kolom untuk Eksplorasi Item Inventaris.

Untuk informasi yang lebih spesifik tentang struktur LookML dalam file model, lihat halaman dokumentasi Istilah-istilah dan konsep LookML.

Baca halaman dokumentasi Parameter model, Parameter eksplorasi, dan Parameter gabungan untuk mempelajari parameter LookML lebih lanjut dalam file model.

File tampilan

File tampilan umumnya menentukan satu "tampilan" dalam Looker. Tampilan sesuai dengan satu tabel dalam database Anda atau satu tabel turunan. File tampilan menentukan tabel yang akan dikueri dan kolom (dimensi dan ukuran) yang akan disertakan dari tabel tersebut sehingga pengguna dapat membuat kueri dengan kolom tersebut di UI Looker.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file tampilan.

Struktur dan sintaksis umum

Dalam tanda kurung kurawal setiap tampilan, { }, terdapat definisi kolom, yang biasanya sesuai dengan kolom dalam tabel dasar atau perhitungan di Looker. Looker mengategorikan sebagian besar definisi ini sebagai dimensi atau ukuran.

Dalam contoh file tampilan berikut, file orders.view menyertakan definisi untuk dimensi id, status, dan user_id, grup dimensi created, dan ukuran count:

view: orders {
  sql_table_name: demo_db.orders ;;
  drill_fields: [id]

  dimension: id {
    primary_key: yes
    type: number
    sql: ${TABLE}.id ;;
  }

  dimension: status {
    type: string
    sql: ${TABLE}.status ;;
  }

  dimension: user_id {
    type: number
    # hidden: yes
    sql: ${TABLE}.user_id ;;
  }

    dimension_group: created {
    type: time
    timeframes: [
      raw,
      time,
      date,
      week,
      month,
      quarter,
      year
    ]
    sql: ${TABLE}.created_at ;;
  }

  measure: count {
    type: count
    drill_fields: [id, users.id, users.first_name, users.last_name, order_items.count]
  }
}

Definisi kolom ini dalam tampilan orders menampilkan kolom Created Date, ID, Status, User ID, dan Count di pemilih kolom untuk Eksplorasi Orders.

Pengguna yang memiliki akses ke Eksplorasi Orders dapat membuat kueri Eksplorasi Orders dengan memilih dan memfilter kolom ini.

Selain dimensi dan ukuran, Anda juga dapat membuat beberapa dimensi berbasis waktu sekaligus menggunakan grup dimensi atau menentukan filter untuk pengguna dengan kolom filter. Buka halaman dokumentasi Parameter tampilan untuk mempelajari parameter LookML lebih lanjut dalam file tampilan, dan buka halaman dokumentasi Parameter kolom untuk mengetahui informasi tentang parameter LookML yang digunakan untuk menentukan dimensi, ukuran, grup dimensi, dan kolom filter di LookML.

File dasbor

Looker mendukung dua jenis dasbor:

  • Dasbor yang ditentukan pengguna, yang dapat dibuat oleh pengguna non-developer tanpa menggunakan LookML. Untuk mengetahui detailnya, lihat halaman dokumentasi Membuat dasbor yang ditentukan pengguna.
  • Dasbor LookML, yang disimpan sebagai file yang dikontrol versinya dan terkait dengan project.

Jika project Anda berisi dasbor LookML, dasbor tersebut akan ditentukan dalam file dasbor khusus di IDE, dengan ekstensi .dashboard.lookml.

Untuk mengetahui informasi selengkapnya tentang dasbor LookML, lihat halaman dokumentasi Membuat dasbor LookML.

File dokumen

File dokumen Looker memungkinkan Anda menulis dokumentasi atau catatan lain tentang model data Looker menggunakan Markdown yang disesuaikan dengan GitHub. Hal ini dapat membantu pengguna Anda memahami cara organisasi Anda menggunakan Looker.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file dokumen.

Melihat dokumen di luar IDE

Untuk melihat dokumen di luar IDE, yang harus Anda lakukan untuk memanfaatkan fitur navigasi yang dijelaskan di halaman ini, pilih opsi View Document dari menu See file actions untuk file dokumen:

Anda dapat mendistribusikan URL halaman hasil kepada pengguna lain sehingga mereka dapat langsung mengakses dokumen tanpa harus membuka menu Develop Looker untuk mencapainya.

Menambahkan struktur navigasi ke dokumen

Anda dapat menambahkan sidebar ke file dokumen sehingga pengguna dapat melihat struktur informasi dan berpindah antar-dokumen.

Untuk menambahkan navigasi sidebar untuk dokumen, buat bagian navigasi yang dimulai di baris pertama dokumen. Tandai awal dan akhir bagian navigasi Anda dengan tiga tanda hubung (---).

Anda dapat menggunakan parameter berikut di bagian navigasi:

Anda dapat menggunakan navigation: true dalam file dokumen untuk menambahkan sidebar navigasi ke dokumen tersebut. Misalnya, Anda dapat menambahkan kode berikut ke bagian atas file Markdown:

---
navigation: true
---

Kode ini menambahkan sidebar navigasi dengan link ke semua dokumen project ke dokumen. Jika Anda hanya menyertakan navigation: true dalam dokumen, sidebar dokumen tersebut akan mencantumkan semua dokumen project dalam urutan abjad berdasarkan nama file.

Selain itu, Anda mungkin mendapati bahwa pengorganisasian berdasarkan nama file abjad tidak ideal, atau Anda mungkin memiliki beberapa dokumen yang tidak ingin ditampilkan di navigasi:

Sidebar mencantumkan Dokumen Empat, Dokumen Satu, Dokumen Tiga, dan Dokumen Dua dalam urutan abjad, beserta dokumen berjudul Jangan Tampilkan.

Dalam contoh ini, Anda mungkin ingin mencantumkan dokumen Document One, Document Two, Document Three, dan Document Four dalam urutan numerik, bukan urutan abjad, serta menyembunyikan dokumen Do Not Display dari sidebar navigasi.

Untuk mengubah urutan dokumen di sidebar navigasi, atau hanya menampilkan sebagian dokumen di sidebar, Anda dapat menggunakan format ini:

---
navigation:
  - document_one
  - document_two
  - document_three
  - document_four
---

Sekarang navigasi hanya akan menampilkan file dokumen yang ingin Anda tampilkan, dan file tersebut akan muncul dalam urutan yang lebih logis:

Sidebar mencantumkan dokumen dalam urutan numerik, dan dokumen Jangan Tampilkan tidak lagi ditampilkan.

title

Secara default, sidebar menampilkan judul dokumen (jika dokumen dimulai dengan judul), atau nama file dokumen jika tidak ada judul dalam file. Anda dapat menambahkan parameter title di bagian atas dokumen untuk mengubah cara dokumen ditampilkan di sidebar navigasi:

---
title: New Title for Users
---

Judul ini akan digunakan sebagai teks link di sidebar navigasi semua dokumen, kecuali jika Anda menentukan label yang berbeda di bagian navigasi dokumen.

label

Jika ingin mengubah cara dokumen dicantumkan di sidebar navigasi, Anda dapat menggunakan parameter document dan label seperti ini:

---
navigation:
  - document_one
  - document: document_two
    label: Customized Label for Document Two
  - document_three
  - document_four
---

Nilai label menentukan cara dokumen ditampilkan di navigasi sidebar dokumen, meskipun dokumen yang dirujuk memiliki parameter title sendiri.

Contoh sebelumnya terlihat seperti ini di sidebar dokumen:

Halaman document_two dicantumkan sebagai Label yang Disesuaikan untuk Dokumen Dua di sidebar.

section

Jika ingin membagi sidebar navigasi menjadi beberapa bagian, Anda dapat menggunakan parameter section seperti ini:

---
navigation:
  - document_one
  - document_two
  - section: My Section Name
  - document_three
  - document_four
---

Dalam contoh ini, parameter section menambahkan jeda bagian dan judul teks My Section Name ke sidebar.

Judul teks itu sendiri bukan link; judul teks tidak merujuk ke file dokumen Anda.

File data

File data adalah file JSON dengan ekstensi file .json, .topojson, atau .geojson.

Parameter map_layer memungkinkan Anda menggunakan file JSON sebagai peta kustom yang kemudian dapat digunakan untuk memplot data Anda di Looker.

Kemudian, Anda menggunakan parameter map_layer_name dengan dimensi sehingga dapat mengaitkan nilai data (seperti "Paris") dengan wilayah geografis di peta kustom Anda.

Anda dapat mengedit file JSON di LookML IDE, lalu memilih Save.

Untuk proses debug, Anda dapat memilih View Raw dengan memilih menu See file actions di samping nama file untuk melihat file dalam format mentah. Jika memiliki ekstensi yang tepat untuk melihat JSON di browser, Anda juga akan memiliki opsi untuk melihat file dalam format Parsed.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara mengupload file JSON ke project LookML.

File manifes project

Project Anda mungkin berisi file manifes project, yang digunakan untuk tugas berikut:

Lihat halaman dokumentasi Parameter manifes project untuk melihat contoh file manifes dan parameter yang mungkin untuk file manifes. Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file manifes project.

Perhatikan hal-hal berikut terkait file manifes project:

  • Setiap project hanya dapat memiliki satu file manifes, dan file tersebut harus diberi nama manifest.lkml dan berada di tingkat root struktur direktori project Anda dan di repositori Git Anda.
  • Looker tidak mendukung file manifes project kosong. Jika file manifes Anda kosong, hapus file tersebut.
  • Setiap project hanya dapat memiliki satu file manifes.
  • File manifes project harus diberi nama manifest.lkml dan berada di tingkat root struktur direktori project Anda.

File kunci manifes

File kunci manifes dibuat secara otomatis saat dependensi jarak jauh ditambahkan ke file manifes project. Looker menggunakan file kunci manifes untuk melacak versi project jarak jauh yang ditentukan dalam file manifes. File kunci manifes tercantum di panel file browser Looker IDE dan memiliki nama file manifest_lock.lkml.

Developer Looker tidak perlu membuat atau mengedit file kunci manifes, karena file kunci dikelola secara otomatis oleh Looker.

Untuk mengetahui informasi selengkapnya, lihat halaman dokumentasi Mengimpor file dari project lain.

File string lokal

Jika Anda melokalkan model data, Anda harus membuat file string lokal untuk setiap lokalitas yang ingin Anda lokalkan, termasuk lokalitas default Anda (misalnya, sering kali bahasa Inggris di Amerika Serikat).

File string lokal mencantumkan pasangan nilai kunci untuk setiap label dan deskripsi yang Anda lokalkan dalam model. File string untuk setiap lokalitas harus menyediakan terjemahan lokalitas tersebut untuk setiap label atau deskripsi. Informasi selengkapnya tentang cara membuat file string lokal muncul di halaman dokumentasi Melokalkan model LookML.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file string lokal.

File Eksplorasi

Eksplorasi adalah tampilan yang dapat dikueri pengguna. Eksplorasi adalah titik awal untuk kueri atau, dalam istilah SQL, FROM dalam pernyataan SQL. Lihat halaman dokumentasi Melihat dan berinteraksi dengan Eksplorasi di Looker untuk mengetahui informasi tentang cara pengguna berinteraksi dengan Eksplorasi untuk mengkueri data Anda.

Eksplorasi biasanya ditentukan dalam file model. Namun, terkadang Anda memerlukan file Eksplorasi terpisah untuk tabel turunan, atau untuk memperluas atau menyempurnakan Eksplorasi di seluruh model.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file Eksplorasi.

File pengujian data

Project Anda mungkin memiliki file pengujian data yang digunakan untuk memverifikasi logika model LookML Anda. Pengujian data dapat berada dalam file model atau dalam file tampilan, tetapi jika developer Anda ingin menggunakan pengujian data yang sama di beberapa model yang berbeda, sebaiknya simpan pengujian data dalam file khusus mereka sendiri.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file pengujian data.

File penajaman

Project Anda mungkin memiliki file yang digunakan untuk penajaman LookML. Dengan penajaman LookML, Anda dapat menyesuaikan tampilan atau Eksplorasi yang ada tanpa mengedit file LookML yang berisi tampilan atau Eksplorasi tersebut. Penajaman LookML dapat berada dalam file model, tampilan, atau Eksplorasi, atau dalam file khusus mereka sendiri.

Lihat halaman dokumentasi Mengelola file dan folder LookML untuk mengetahui petunjuk cara membuat file project LookML, termasuk file penajaman.

File lainnya

Banyak elemen LookML dapat ditempatkan dalam file yang berbeda di project Anda, atau dalam file khusus mereka sendiri. Misalnya, pengujian data dapat ditempatkan dalam file model, file tampilan, atau file .lkml khusus mereka sendiri.