sertakan

Penggunaan


include: "/views/airports.view"
Hierarki
include

- atau -

include

- atau -

include
Nilai Default
Tidak ada

Menerima
String yang berisi nama file atau pola

Definisi

Parameter include menentukan file LookML yang akan tersedia untuk model, tampilan, atau Eksplorasi. Jika ingin menggunakan atau mereferensikan file LookML dalam file lain, Anda harus menambahkannya dengan parameter include.

Anda dapat menggunakan parameter include dalam file model, file tampilan, dan file Eksplorasi. Parameter include dapat mereferensikan berbagai jenis file LookML, bergantung pada konteksnya.

Dalam file model, Anda dapat menggunakan include untuk mereferensikan jenis file berikut:

Dalam file tampilan, Anda dapat menggunakan include untuk mereferensikan jenis file berikut:

Dalam file Jelajahi, Anda dapat menggunakan include untuk mereferensikan jenis file berikut:

Anda juga dapat menggunakan include untuk memasukkan file dari project lain. Lihat halaman dokumentasi Mengimpor file dari project lain untuk mengetahui informasi tentang menyertakan file dari project lain.

Perhatikan hal berikut saat menggunakan include:

  • Anda tidak perlu menggunakan include untuk jenis file non-LookML, seperti file dokumentasi atau file data.
  • Penyertaan file bersifat menyeluruh, sehingga semua informasi file yang disertakan ditambahkan ke file yang menyertakan.
  • Anda dapat menggunakan beberapa parameter include dalam satu file.
  • Anda dapat menggunakan karakter pengganti * untuk menunjukkan file dengan konvensi penamaan strategis atau dengan ekstensi yang sama. Misalnya, Anda dapat menggunakan "*base.dashboard" untuk mencocokkan dan menyertakan "database.dashboard" dan "crunchbase.dashboard". Anda dapat menggunakan "*.dashboard" untuk menunjukkan semua file dengan ekstensi .dashboard.
  • Anda dapat menggunakan karakter pengganti * untuk menyertakan semua file dalam direktori. Misalnya, Anda dapat menyertakan semua file tampilan di direktori views/users/ dengan menentukan include: "/views/users/*.view". Lihat halaman dokumentasi tentang folder IDE untuk mengetahui informasi selengkapnya tentang penggunaan karakter pengganti dengan folder IDE.

Menggunakan include dalam file model

Anda dapat menggunakan parameter include dalam file model untuk menyertakan tampilan dan dasbor atau Eksplorasi.

Menyertakan tampilan dan dasbor dalam model

Gunakan parameter include dalam file model untuk menentukan file dasbor dan tampilan yang akan tersedia untuk model tersebut. Jika ingin menggunakan atau mereferensikan file LookML dalam model, Anda harus menambahkannya dengan parameter include.

Dalam parameter include, gunakan ekstensi .view untuk file tampilan dan ekstensi .dashboard untuk dasbor. Anda dapat menghilangkan bagian .lkml dan .lookml dari ekstensi ini.

Anda dapat menggunakan karakter pengganti * untuk menunjukkan file dengan konvensi penamaan strategis atau dengan ekstensi yang sama. Anda juga dapat menggunakan karakter pengganti * bersama dengan jalur direktori untuk menentukan beberapa file, seperti yang dijelaskan di bagian Contoh karakter pengganti di halaman parameter include.

Misalnya, Anda dapat menggunakan parameter include berikut dalam file model:

include: "/**/*.dashboard"
include: "/*/*base.view.lkml"
include: "//e_commerce/views/*.view.lkml"

Parameter ini akan mencakup file berikut:

  • Semua file dasbor di direktori mana pun dalam project Anda
  • File tampilan yang diakhiri dengan base.view.lkml di direktori turunan langsung project, seperti /views/database.view.lkml atau /public/crunchbase.view.lkml
  • Semua file tampilan di direktori /views/ dari project yang diimpor bernama e_commerce

Jika project Anda memiliki banyak file tampilan atau jika project Anda menggunakan tabel turunan persisten (PDT), Anda harus menghindari penyertaan semua file tampilan dalam model. Sebagai gantinya, sertakan file tampilan individual seperti ini. Berikut adalah contoh menyertakan file tampilan individual dan semua dasbor dalam project:

include: "/views/order.view"
include: "/views/user.view"
include: "/**/*.dashboard"

Menyertakan model dalam model

Anda tidak dapat menyertakan file model dari project lain. Sebagai gantinya, untuk menggunakan kembali, memperbaiki, atau memperluas Eksplorasi di seluruh project, di project yang diimpor, Anda dapat membuat file Eksplorasi terpisah, lalu menyertakan file Eksplorasi tersebut dalam project lain. Lihat Menyertakan Eksplorasi dalam Model untuk mengetahui informasi selengkapnya.

Menyertakan Eksplorasi dalam model

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

Jika Anda memiliki file Explore terpisah, Anda harus menggunakan parameter include dalam file model untuk menyertakannya. Dalam parameter include, gunakan ekstensi .explore.lkml untuk file Explore.

Contoh berikut adalah file model yang memiliki dua Eksplorasi:

  • aircraft_new Explore, yang ditentukan dalam filenya sendiri yang disebut aircraft_new.explore.lkml di folder explores. Karena Eksplorasi tersebut ditentukan dalam filenya sendiri, Anda harus menentukan jalur file Eksplorasi dalam parameter include.
  • Eksplorasi accidents, yang ditentukan dalam file model. Karena ditentukan dalam file model itu sendiri, Anda tidak perlu menggunakan parameter include untuknya dalam model. Namun, Anda memerlukan include untuk tampilan tempat Eksplorasi accidents didasarkan.
connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"

explore: accidents {
  view_name: accidents
  from: accidents
}

Menyertakan pengujian data dalam model

Pengujian data dapat ditentukan langsung dalam file model atau file tampilan. Namun, Anda juga dapat membuat file pengujian data terpisah jika ingin menggunakan kembali pengujian data di beberapa tempat dalam project.

Jika Anda memiliki file pengujian data terpisah, Anda harus menggunakan parameter include dalam file model atau file tampilan agar dapat menjalankan pengujian data. Dalam parameter include, gunakan ekstensi .lkml untuk file pengujian data.

Misalnya, berikut adalah kutipan dari file model yang menyertakan file pengujian data:

connection: "faa"

include: "/explores/aircraft_new.explore.lkml"
include: "/views/accidents.view"
include: "/tests/data_tests.lkml"

. . .

Setelah menyertakan file pengujian data dalam file model, Anda dapat menjalankan pengujian data untuk memverifikasi bahwa pengujian data Anda berfungsi dengan baik dan untuk melihat apakah logika model Anda lulus pengujian.

Anda juga dapat menyertakan file pengujian data dalam file tampilan, seperti yang dijelaskan di bagianMenyertakan pengujian data dalam tampilan di halaman ini.

Menggunakan include dalam file tampilan

Pada umumnya, Anda tidak perlu menggunakan include dalam file tampilan. Namun, ada beberapa kasus ketika Anda ingin menyertakan file dalam file tampilan:

Menyertakan tampilan dalam tampilan (untuk memperluas atau mempertajam)

Anda juga dapat menyertakan file tampilan dalam file tampilan lain untuk memperluas atau memperbaiki tampilan yang disertakan.

Misalnya, berikut adalah file tampilan marketing_order_fields yang menyertakan file tampilan basic_order_fields, lalu memperluasnya:

include: "/views/basic_order_fields.view"
view: marketing_order_fields {
  extends: [basic_order_fields]  # The file that contains the basic_order_fields
}                                # view should be included

Menyertakan Jelajah dalam tampilan

Dalam sebagian besar kasus, Anda tidak perlu menyertakan Jelajahi dalam tampilan. Namun, tabel turunan native adalah kasus khusus karena ditentukan dalam file tampilan sendiri yang memiliki parameter explore_source. Anda menggunakan parameter explore_source untuk menentukan Eksplorasi dan menentukan kolom yang diinginkan serta karakteristik lain yang diinginkan untuk tabel turunan native. Eksplorasi biasanya ditentukan dalam file model, tetapi dalam kasus tabel turunan native, akan lebih baik jika membuat file terpisah untuk Eksplorasi menggunakan ekstensi file .explore.lkml. Jika Anda membuat file Eksplorasi terpisah, Anda harus menyertakan file Eksplorasi dalam file tampilan tabel turunan native.

Berikut adalah contoh penggunaan include dalam file tampilan tabel turunan native untuk mengarah ke file Explore:

include: "/explores/order_items.explore.lkml"

view: user_order_facts {
  derived_table: {
    explore_source: order_items {
      column: user_id {field: order_items.user_id}
      column: lifetime_number_of_orders {field: order_items.order_count}
      column: lifetime_customer_value {field: order_items.total_revenue}
      derived_column: average_customer_order {
        sql:  lifetime_customer_value / lifetime_number_of_orders ;;
      }
    }
  }
  dimension: user_id {hidden: yes}
  dimension: lifetime_number_of_orders {type: number}
  dimension: lifetime_customer_value {type: number}
  dimension: average_customer_order {type: number}
}

Lihat dokumentasi kami tentang menggunakan pernyataan include untuk memungkinkan kolom dirujuk guna mengetahui informasi selengkapnya tentang file Jelajah untuk tabel turunan native.

Menyertakan pengujian data dalam tampilan

Pengujian data dapat ditentukan langsung dalam file model atau file tampilan. Namun, Anda juga dapat membuat file pengujian data terpisah jika ingin menggunakan kembali pengujian data di beberapa tempat dalam project.

Jika Anda memiliki file pengujian data terpisah, Anda harus menggunakan parameter include dalam file model atau file tampilan agar dapat menjalankan pengujian data. Dalam parameter include, gunakan ekstensi .lkml untuk file pengujian data.

Misalnya, berikut adalah kutipan dari file tampilan yang menyertakan file pengujian data:

include: "/tests/data_tests.lkml"

view: orders {
  sql_table_name: looker.orders ;;

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

. . .

Setelah menyertakan file pengujian data dalam file tampilan, Anda dapat menjalankan pengujian data untuk memverifikasi bahwa pengujian data Anda berfungsi dengan baik dan untuk melihat apakah logika tampilan Anda lulus pengujian.

Anda juga dapat menyertakan file pengujian data dalam file model, seperti yang dijelaskan di bagian Menyertakan pengujian data dalam model di halaman ini.

Menggunakan include dalam file Jelajahi

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

Jika memiliki file Explore terpisah, Anda dapat menggunakan parameter include untuk menyertakan tampilan atau Eksplorasi lainnya.

Menyertakan tampilan dalam Eksplorasi

Jika memiliki file Eksplorasi terpisah, Anda harus menyertakan tampilan apa pun yang digunakan oleh Eksplorasi. Gunakan ekstensi file .view untuk melihat file. Anda dapat menghilangkan bagian .lkml dari ekstensi file. Berikut adalah contoh file Jelajah yang menyertakan dua tampilan yang digunakannya:

include: "/views/aircraft.view"
include: "/views/aircraft_types.view"

explore: aircraft {
  join: aircraft_types {
    type: left_outer
    sql_on: ${aircraft.aircraft_type_id} = ${aircraft_types.aircraft_type_id} ;;
    relationship: many_to_one
  }
}

Menyertakan Eksplorasi dalam Eksplorasi

Anda dapat menyertakan satu file Eksplorasi dalam file Eksplorasi lain, seperti saat Anda memperluas atau memperbaiki Eksplorasi. Gunakan parameter include dan tambahkan ekstensi file .explore.lkml.

Berikut adalah contoh file Eksplorasi yang menyertakan file Eksplorasi lain, lalu memperluas Eksplorasi:

include: "/explores/base.explore.lkml"

explore: aircraft_information {
  extends: [aircraft]

Menggunakan include dengan folder IDE

Saat mengatur file project LookML ke dalam folder, Anda harus memberikan jalur untuk file dalam pernyataan include.

Anda dapat menggunakan jalur absolut atau relatif dalam pernyataan include (lihat bagian Sintaksis jalur di halaman ini untuk melihat contohnya), dan Anda dapat menggunakan karakter pengganti * dan ** untuk menyertakan beberapa file sekaligus (lihat bagian Contoh karakter pengganti di halaman ini untuk melihat contohnya).

Misalnya, anggaplah Anda memiliki struktur direktori ini di project, dengan konten tingkat teratas berikut di folder views:

  • Folder orders, yang berisi file tampilan order_facts dan order_items
  • Folder users, yang berisi file tampilan user_with_age_extension, users, dan users_extended
  • File tampilan individu distribution_centers, events, inventory_items, dan products

Contoh struktur direktori dengan folder untuk Eksplorasi, model, dan tampilan.

Pernyataan berikut akan menyertakan tampilan products, tampilan order_facts, dan semua tampilan di direktori /views/users/:

include: "/views/products.view"
include: "/views/orders/order_facts.view"
include: "/views/users/*.view"

Saat Anda mengubah jalur file, pastikan untuk memperbarui pernyataan include di project agar sesuai dengan jalur baru file. Anda mungkin melihat peringatan validasi LookML pada pernyataan include lama jika pernyataan tersebut tidak lagi merujuk ke file atau jalur file yang ada. Selain itu, Anda mungkin melihat error validasi LookML untuk objek yang dirujuk yang tidak dapat ditemukan lagi karena jalur filenya telah berubah.

Sintaksis jalur

Berikut beberapa contoh sintaksis yang dapat Anda gunakan untuk menyertakan file:

Sintaksis Deskripsi
PATH Jalur relatif yang dimulai dari lokasi file saat ini.
./PATH Jalur relatif yang dimulai dari lokasi file saat ini. Contoh ini mengarah ke file yang sama dengan contoh sebelumnya: PATH.
../PATH Jalur relatif yang dimulai dari direktori induk file saat ini.
/PATH Jalur absolut yang dimulai dari root project saat ini.
//PROJECT_NAME/PATH Jalur absolut yang dimulai dari root project yang diimpor bernama PROJECT_NAME.

Menggunakan karakter pengganti

Untuk project yang hanya memerlukan pengelolaan beberapa file, Anda dapat mencantumkan setiap file dalam parameter include-nya sendiri, seperti ini:

include: "/dashboards/user_info.dashboard"
include: "/views/users.view"

Untuk project dengan banyak file yang akan disertakan, Anda dapat mengurangi jumlah parameter include yang perlu ditulis dengan menggunakan karakter pengganti untuk menyertakan beberapa file sekaligus:

Penggunaan karakter pengganti dapat sangat membantu selama pengembangan saat Anda perlu membuat perbaikan sementara untuk peringatan validasi LookML, terutama saat mengatur project yang ada ke dalam folder IDE. Namun, pertimbangkan hal berikut saat menggunakan karakter pengganti dalam pernyataan include:

Menggunakan karakter pengganti dengan folder IDE

Anda dapat menggunakan karakter pengganti bersama dengan folder IDE untuk menyertakan file dalam direktori tertentu di project LookML Anda.

Misalnya, pernyataan include ini mereferensikan semua file dalam direktori /explores/ project LookML:

include: "/explores/*"

Menggunakan karakter pengganti untuk jenis file tertentu

Anda dapat menggunakan karakter pengganti untuk mereferensikan semua file dari jenis tertentu. Misalnya, pernyataan include ini mereferensikan semua file Eksplorasi dalam project LookML:

include: "/**/*.explore.lkml"

Lihat bagian Jenis file dalam project LookML di halaman dokumentasi Memahami file project LookML untuk mengetahui daftar jenis file LookML dan ekstensi filenya.

Menggunakan karakter pengganti dengan pola penamaan strategis

Anda juga dapat menggunakan karakter pengganti dengan penamaan file strategis untuk lebih mengoptimalkan pernyataan include. Misalnya, daripada memberi nama file seperti ini:

/views/apple.view
/views/banana.view
/views/cherry.view
/views/orange.view
/views/celery.view

Anda dapat menambahkan awalan atau akhiran strategis ke nama file, seperti ini:

/views/apple.fruit.view
/views/banana.fruit.view
/views/cherry.fruit.view
/views/orange.fruit.view
/views/celery.vegetable.view

Kemudian, gunakan karakter pengganti untuk mereferensikan hanya sufiks .fruit dengan menggunakan include ini:

include: "/views/*.fruit.view"

Contoh karakter pengganti

Berikut beberapa contoh penggunaan karakter pengganti (perhatikan bahwa Anda dapat mengganti PATH dengan sintaksis jalur dalam tabel sebelumnya):

Sintaksis Deskripsi
PATH/*.view Mencocokkan file yang diakhiri dengan .view menggunakan karakter pengganti di PATH.
PATH/*.view.lkml Mencocokkan file yang diakhiri dengan .view.lkml menggunakan karakter pengganti di PATH.

Karena file tampilan memiliki ekstensi .view.lkml, contoh ini menentukan file yang sama seperti contoh sebelumnya, PATH/*.view. Bagian .lkml tidak ditampilkan di IDE, dan bagian .lkml juga tidak diperlukan untuk pernyataan include. Namun, Anda dapat menggunakan karakter pengganti untuk memanfaatkan bagian umum ekstensi file ini. Lihat halaman dokumentasi file project LookML untuk mengetahui daftar ekstensi file project.
PATH/*.lkml Mencocokkan file yang diakhiri dengan .lkml menggunakan karakter pengganti di PATH.

Perhatikan bahwa beberapa jenis file menggunakan .lkml sebagai bagian akhir ekstensi file, seperti .view.lkml dan .model.lkml. Bagian .lkml tidak ditampilkan di IDE, dan bagian .lkml juga tidak diperlukan untuk pernyataan include. Namun, Anda dapat menggunakan karakter pengganti untuk memanfaatkan bagian umum ekstensi file ini. Lihat halaman dokumentasi file project LookML untuk mengetahui daftar ekstensi file project.
PATH/myfile.* Mencocokkan file dengan karakter pengganti bernama myfile dengan jenis ekstensi apa pun di PATH.
PATH/myfile.*.lkml Mencocokkan file bernama myfile dengan jenis ekstensi .lkml apa pun di PATH.
PATH/my*file.view Mencocokkan file karakter pengganti yang dimulai dengan my dan diakhiri dengan file.view di PATH.
PATH/my*fi*le.view Karakter pengganti yang cocok dengan file yang diawali dengan my, diikuti dengan beberapa karakter, lalu fi, beberapa karakter tambahan, dan diakhiri dengan le.view di PATH.
PATH/*/myfile.lkml Karakter pengganti nama folder (hanya cocok dengan satu tingkat susunan). Mencocokkan semua file myfile.lkml di direktori turunan langsung PATH.
PATH/**/my_file.view Pencocokan karakter pengganti rekursif (mencocokkan jumlah nesting apa pun) untuk semua file yang disebut my_file.view.lkml di PATH dan semua subdirektori.
PATH/**/*.view Pencocokan karakter pengganti rekursif yang mencocokkan semua file yang diakhiri dengan .view.lkml di subdirektori PATH.
PATH/**/my_folder/myfile.view Karakter pengganti berulang yang cocok dengan subjalur /my_folder/myfile.view di kedalaman mana pun di bawah PATH.

Contoh

Lihat bagian sebelumnya untuk mengetahui contoh penggunaan include dalam file model, file tampilan, dan file Jelajahi.

Hal-hal yang perlu dipertimbangkan

Menyertakan semua file tampilan dapat memengaruhi performa validasi LookML

Jika project Anda memiliki banyak file tampilan dan Anda menyertakan semuanya dalam file model, hal ini dapat memengaruhi performa Validator LookML. Karena LookML Validator memeriksa semua file tampilan yang disertakan dalam model, Anda hanya boleh menyertakan file tampilan yang diperlukan dalam parameter include file model.

Pertimbangkan untuk menggunakan konvensi penamaan strategis untuk file tampilan agar memudahkan penyertaan grup tampilan dalam model (lihat contoh di Menggunakan karakter pengganti dengan pola penamaan strategis di halaman ini). Atau, Anda dapat menggunakan folder IDE untuk mengatur tampilan ke dalam folder. Kemudian, Anda dapat menggunakan karakter pengganti * untuk menyertakan semua tampilan dalam satu folder, alih-alih menyertakan semua tampilan dalam project Anda. Lihat bagian tentang menggunakan include dengan folder IDE untuk mengetahui informasi.

Menyertakan semua file tampilan dapat mengacaukan skema database Anda

Untuk project yang menggunakan tabel turunan persisten (PDT), Anda dapat menyertakan file tampilan PDT dalam file model. Namun, setiap file model yang menyertakan file tampilan PDT akan membuat salinan PDT dalam skema sementara di database Anda. Jika memiliki beberapa file model dan menyertakan semua file tampilan dalam file model, Anda dapat menambahkan kekacauan yang tidak perlu ke skema sementara database. Oleh karena itu, pastikan Anda hanya menyertakan file tampilan PDT dalam file model yang memerlukan PDT.