Anda dapat menelusuri dan mengelola resource Cloud Firestore menggunakan Knowledge Catalog, yang merupakan platform untuk menyimpan, mengelola, dan mengakses metadata Anda. Anda dapat menggunakan Knowledge Catalog untuk menganalisis metadata Cloud Firestore dan membantu tugas seperti:
- Analisis, termasuk dependensi dan kesesuaian untuk kasus penggunaan
- Manajemen perubahan
- Evolusi skema
Knowledge Catalog diaktifkan secara default di database Cloud Firestore baru dan yang sudah ada, serta otomatis mengambil metadata berikut:
| Resource | Jenis | Kolom |
|---|---|---|
| Database | Bidang kontrol |
|
| Skema database | Bidang data |
|
Sebelum memulai
Aktifkan Knowledge Catalog API (dataplex.googleapis.com).
- Sebelum dapat mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin
roles/serviceusage.serviceUsageAdmin, yang berisi izinserviceusage.services.enable. Pelajari cara memberikan peran. - Untuk mengaktifkan API, lihat Mengaktifkan API.
Untuk menggunakan insight Knowledge Catalog dengan Cloud Firestore, Anda harus memiliki database Cloud Firestore terlebih dahulu. Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola database.
Peran yang diperlukan untuk mengakses hasil penelusuran
Untuk menelusuri dan melihat metadata Cloud Firestore di Knowledge Catalog, akun utama harus memiliki izin untuk melihat resource Cloud Firestore, termasuk izin dataplex.projects.search.
Untuk memberikan izin ini kepada akun utama - seperti pengguna,
grup, atau akun layanan, tetapkan peran IAM
Cloud Datastore Viewer (roles/datastore.viewer)
pada project yang berisi resource Cloud Firestore.
| Operasi Knowledge Catalog | Resource Cloud Firestore | Peran atau izin yang diperlukan |
|---|---|---|
| Menelusuri resource Cloud Firestore | Database | datastore.databases.getMetadata |
| Skema database | datastore.schemas.get |
Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses. Untuk mengetahui informasi selengkapnya tentang peran IAM Cloud Firestore, lihat peran dan izin Cloud Firestore.
Peran yang diperlukan untuk menelusuri entri
Untuk menelusuri entri, Anda memerlukan setidaknya salah satu peran IAM berikut pada project yang digunakan untuk penelusuran:
- Dataplex Catalog Admin (
roles/dataplex.catalogAdmin) - Dataplex Catalog Editor (
roles/dataplex.catalogEditor) - Dataplex Catalog Viewer (
roles/dataplex.catalogViewer)
Izin pada hasil penelusuran diperiksa secara independen dari project yang dipilih. Untuk mengetahui informasi selengkapnya, lihat Menelusuri aset data dengan Knowledge Catalog.
Jenis penemuan metadata
Penemuan metadata Knowledge Catalog adalah proses otomatis yang memindai sumber data yang terhubung - seperti Cloud Firestore - untuk mengidentifikasi aset data (seperti koleksi dan database) dan mengekstrak metadata teknisnya seperti skema, deskripsi, dan lokasi ke dalam katalog Knowledge Catalog. Proses ini berjalan secara berkala untuk menjaga katalog tetap sinkron dengan sistem sumber.
Penelusuran kata kunci dan penelusuran bahasa alami
Knowledge Catalog mendukung penelusuran kata kunci dan bahasa alami.
- Penelusuran kata kunci memungkinkan Anda menemukan resource menggunakan kata kunci, filter, dan sintaksis tertentu. Misalnya, Anda dapat memasukkan
system=Firestore AND type=Databaseuntuk melihat semua database Cloud Firestore. - Penelusuran bahasa alami (Pratinjau) menggunakan AI untuk memahami kueri semantik. Dengan fitur ini, Anda dapat menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang rumit. Misalnya, Anda dapat memasukkan kueri seperti
List all Firestore databases related to sales.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Contoh: Menemukan skema grup koleksi Cloud Firestore
Untuk memahami proses penemuan metadata, pertimbangkan database Cloud Firestore
bernama user-firestore-database. Dalam database ini, Anda memiliki
skema grup koleksi bernama user-schema.
Setelah penemuan selesai, Anda dapat menelusuri aset ini - user-firestore-database
dan user-schema - di halaman Knowledge Catalog di
Konsol Google Cloud atau menggunakan Knowledge Catalog API.
Kemudian, Anda dapat melihat detail tentang aset dan memperkayanya dengan metadata bisnis atau operasional tambahan.
Memperkaya metadata menggunakan aspek
Jenis aspek adalah resource yang dapat digunakan kembali dan dapat Anda gunakan sebagai template untuk aspek. Jenis aspek membantu Anda menghindari duplikasi pekerjaan dan aspek yang tidak lengkap. Anda dapat menggunakan Knowledge Catalog untuk membuat jenis aspek yang Anda butuhkan.
Setelah membuat jenis aspek kustom, Anda dapat melampirkan aspek ke resource Cloud Firestore. Dengan melampirkan aspek ke resource, Anda dapat melakukan hal berikut:
- Menambahkan metadata bisnis ke aset
- Menelusuri aset berdasarkan metadata bisnis dan metadata kustom lainnya
Untuk mempelajari lebih lanjut cara membuat jenis aspek dan melampirkan aspek ke Cloud Firestore, lihat Mengelola aspek dan memperkaya metadata.
Menelusuri aset Cloud Firestore
Gunakan halaman penelusuran Knowledge Catalog di Konsol Google Cloud untuk menelusuri aset Cloud Firestore.
Buka halaman Search Knowledge Catalog.
Di panel Filters, klik Systems, lalu pilih Firestore.
Opsional. Di Type aliases, Anda dapat memfilter hasil penelusuran ke jenis aset Cloud Firestore tertentu dengan memilih satu atau beberapa alias jenis berikut:
- Database
- Skema database
- Lainnya
Menggunakan kueri untuk melakukan penelusuran kata kunci
Anda dapat menggunakan kolom penelusuran di Knowledge Catalog untuk menjalankan kueri penelusuran kata kunci. Misalnya, Anda dapat memasukkan
system=Firestore AND type=Database untuk melihat semua database Cloud Firestore.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Untuk melihat semua aset Cloud Firestore, masukkan system=Firestore. Anda dapat memasukkan
kata kunci tertentu. Misalnya, untuk melihat semua database Cloud Firestore:
system=Firestore AND type=Database
Anda juga dapat menggunakan tanda kurung dan operator logika AND dan OR untuk
ekspresi yang kompleks. Untuk mempelajari lebih lanjut ekspresi yang dapat Anda gunakan di
kolom penelusuran, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Anda dapat langsung memasukkan kueri penelusuran untuk aset Cloud Firestore tertentu ke dalam kolom penelusuran. Format string kueri adalah sebagai berikut:
type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"
Ganti kode berikut:
QUERY_STRING: gunakan daftar berikut untuk mengidentifikasi string kueri berdasarkan jenis aset Cloud Firestore yang ingin Anda kueri:firestore-databasefirestore-schema
Contoh kueri mungkin akan terlihat seperti berikut:
type="projects/1234567890/locations/global/entryTypes/firestore-schema"
Menelusuri berdasarkan jenis aspek
Knowledge Catalog menyertakan beberapa jenis aspek bawaan yang dapat Anda gunakan untuk melakukan penelusuran.
Untuk menelusuri berdasarkan jenis aspek, ikuti langkah-langkah berikut:
- Di panel Aspects, klik menu Add more aspect types.
- Masukkan
Firestore, lalu pilih satu atau beberapa jenis aspek berikut untuk membatasi hasil penelusuran ke jenis tersebut.- Database Cloud Firestore
- Skema Cloud Firestore
- Klik Oke.
- Di tabel hasil, klik nama aset untuk melihat metadata aset tersebut.
- Opsional: Tingkatkan atau lihat aset Anda. Anda dapat melakukan salah satu dari tindakan berikut:
- Untuk menambahkan deskripsi rich text aset, di Overview, klik Add .
- Untuk melampirkan aspek ke aset, di Aspects, klik Add .
- Untuk melihat database anggota untuk sebuah instance, klik tab Entry List, lalu klik Show all children entries in search.
- Di Detail entri, lihat detail lengkap aset. Klik nama entri untuk melihat entri tambahan.
Penelusuran Bahasa Alami di Cloud Firestore
Penelusuran bahasa alami (Pratinjau) menggunakan AI untuk memahami kueri semantik. Dengan fitur ini, Anda dapat menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang rumit. Misalnya, Anda dapat memasukkan kueri seperti
List all Firestore collections related to sales.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Penelusuran sintaksis di Cloud Firestore
Penelusuran kata kunci memungkinkan Anda menemukan resource menggunakan kata kunci, filter, dan sintaksis tertentu. Misalnya, Anda dapat memasukkan system=Firestore AND type=Database
untuk melihat semua database Cloud Firestore.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Contoh alur kerja: Lihat perincian dari database ke skema
Untuk melihat perincian dari database ke skema, ikuti langkah-langkah berikut:
Buka halaman Search Knowledge Catalog.
Di panel Filters, pilih Systems, lalu Firestore. Atau, masukkan
system=Firestoredi kolom penelusuran.Pilih database.
Di halaman Firestore details, klik tab Entry list, lalu klik Show all children entries in search.
Di halaman Firestore database details, klik tab Entry list, lalu klik Show all children entries in search. Knowledge Catalog menampilkan grup koleksi dalam database.
Pilih nama grup koleksi, lalu di halaman Collection group details, klik Schema untuk melihat skema.
Opsional: Untuk menambahkan jenis aspek ke database, klik tombol Add aspect.
Harga
Penyimpanan metadata teknis Cloud Firestore di Knowledge Catalog tidak dikenai biaya. Harga standar Knowledge Catalog berlaku untuk panggilan API dan pengayaan metadata bisnis tambahan. Untuk mengetahui informasi selengkapnya, lihat halaman harga Knowledge Catalog.
Keterbatasan
- Hasil kueri dipotong setelah 10.000 grup koleksi diserap.
- Selama penyerapan batch, diperlukan waktu hingga 48 jam agar pembaruan pada database Anda terlihat di Knowledge Catalog.
- Selama penyerapan langsung, perlu waktu hingga 5 menit agar pembaruan pada database Anda terlihat di Knowledge Catalog.
- Grup koleksi tidak diperbarui selama penyerapan live.
- Skema grup koleksi diperbarui selama penyerapan langsung, tetapi pembaruan ini hanya mencakup 100 kolom primitif tingkat atas pertama dalam urutan alfabet. Informasi skema lainnya diperbarui 24 hingga 48 jam setelah penyerapan live.
- Proses ekstraksi mungkin memerlukan waktu beberapa menit.
Langkah berikutnya
- Tentang pengelolaan katalog data di Knowledge Catalog
- Peran Identity and Access Management Knowledge Catalog