dataset Canonical — Panduan Penggunaan
Canonical membantu Anda menyetel definisi data dan query standar untuk satu package yang sudah Anda pilih di Repository: field yang dipakai, ringkasan filter dan join, serta cara membaca dan mengubah data (manifest). Ini bukan pengganti database server Anda — ini satu tempat di aplikasi untuk menyepakati "bagaimana package ini dibaca dan ditulis".
Sebelum Membuka Canonical
- Di Repository, klik salah satu item di bawah nama package yang ingin Anda kerjakan.
- Baru buka Canonical di sidebar.
Tanpa itu, Settings dan banyak layar Canonical bisa menampilkan pesan untuk memilih package di Repository terlebih dahulu.
Tiga Area Utama di Canonical
| Area di menu | Fungsi untuk Anda |
|---|---|
| Settings | Mengatur field yang dipublikasikan (kartu Field Dipilih), field cadangan dari pengembangan (Field Tersedia), dan melihat ringkasan filter, join, urutan, dan limit yang sudah diset (Ringkasan Operasi). |
| Operasi | Menyusun filter, join, urutan, pengelompokan, ringkasan, hitungan, dan batas baris — biasanya lewat jendela modal di atas layar. |
| Manifest | Layar untuk Select, Insert, Update, hapus, unggah, impor, populate, dan lainnya — umumnya memenuhi area konten dengan formulir atau dokumentasi cara pakai. |
Urutan Kerja yang Disarankan
- Repository → pastikan package yang benar sedang dipilih (klik item di bawah namanya).
- Canonical → Settings → rapikan Field Dipilih, naikkan field dari Field Tersedia bila perlu, periksa Ringkasan Operasi.
- Canonical → Operasi → sesuaikan filter dan join sesuai kebutuhan (urutan: sambungkan sumber data → filter → kelompokkan/ringkas → urutkan → batasi jumlah baris).
- Canonical → Manifest → gunakan Select untuk memahami cara membaca data; lalu Insert/Update atau menu lain sesuai kebutuhan.
Settings — Perilaku Layar
Field Dipilih
Daftar kolom yang ikut ke lingkungan siap pakai untuk package ini. Anda bisa mengubah urutan (seret baris), menyunting alias, atau menghapus kolom dari daftar ini.
Field Tersedia
Daftar field dari sisi pengembangan yang bisa Anda tambahkan ke Field Dipilih dengan tautan tambah. Ada pencarian dan opsi tambah field manual (format nama_tabel.nama_kolom). Field yang ditambahkan secara manual biasanya muncul di Field Tersedia dulu; lalu Anda promosikan ke Field Dipilih.
Ringkasan Operasi
Menampilkan apa yang sudah diset untuk filter, join, urutan, grup, ringkasan, rumus, dan batas baris — tanpa membuka lagi tiap modal Operasi. Dari sini Anda juga bisa menghapus beberapa jenis pengaturan lewat tautan yang disediakan.
Operasi
Semua item di grup Operasi membuka modal di atas konten: isi formulir lalu simpan atau batalkan.
| Menu Operasi | Fungsi teknis singkat |
|---|---|
| Aggregate | Menambahkan fungsi agregat pada query (COUNT, SUM, AVG, MIN, MAX): pilih Field sumber lalu jenis agregat. |
| Arithmetic | Menambahkan kolom hasil ekspresi aritmatika atau rumus antara field. |
| Group | Mengatur GROUP BY — pengelompokan baris menurut satu atau lebih field. |
| Order | Mengatur ORDER BY — urutan pengurutan hasil (naik/turun per kolom). |
| Where | Mengatur filter (kondisi WHERE) — membatasi baris yang masuk ke query. |
| Join | Mengatur JOIN antar sumber data/tabel yang relevan dengan package. |
| Limit | Mengatur LIMIT / OFFSET — membatasi jumlah baris yang dikembalikan dan pagination query. |
Alur berpikir: biasanya Join → Where → Group → Aggregate / Arithmetic → Order → Limit.
Manifest
- Select — menampilkan contoh cara membaca data untuk package ini (pagination, filter, satu baris tertentu).
- Insert / Update / Populate / Upload / Import / Mutation / Delete — masing-masing punya formulir atau panduan langkah di layar. Hapus bersifat sensitif; gunakan dengan hati-hati di data nyata.
Jika Ada Masalah
| Gejala | Yang bisa Anda coba |
|---|---|
| Minta pilih package di Repository | Klik item di bawah nama package di Repository, lalu buka lagi menu Canonical. |
| Ringkasan Operasi tidak berubah | Pastikan Anda menyimpan atau menyelesaikan modal Operasi, bukan menutup tanpa menyimpan. |
| Hasil data tidak sesuai ekspektasi | Buka lagi Settings — periksa Field Dipilih dan Ringkasan Operasi — lalu Select di Manifest. |
| Layar Settings kosong | Buka Settings sekali lagi setelah package stabil; hindari berpindah menu terlalu cepat. |
Hubungan dengan Orchestrator
Canonical mengatur definisi query dan field standar untuk membaca/menulis data. Orchestrator mengatur tampilan form, wizard, modal, dan perilaku field di layar. Keduanya bisa memakai package yang sama yang Anda pilih di Repository.