Anda dapat menelusuri dan mengelola resource Firestore menggunakan Knowledge Catalog, yang merupakan platform untuk menyimpan, mengelola, dan mengakses metadata Anda. Anda dapat menggunakan Knowledge Catalog untuk menganalisis metadata Firestore dan membantu tugas seperti:
- Analisis, termasuk dependensi dan kesesuaian untuk kasus penggunaan
- Manajemen perubahan
- Evolusi skema
Knowledge Catalog diaktifkan secara default di database Firestore baru dan yang sudah ada, serta otomatis mengambil metadata berikut:
| Resource | Jenis | Kolom |
|---|---|---|
| Database | Bidang kontrol |
|
| Skema database | Bidang data |
|
Sebelum memulai
Untuk menggunakan insight Knowledge Catalog dengan Firestore, Anda harus memiliki database Firestore terlebih dahulu. Untuk mengetahui informasi selengkapnya, lihat Membuat dan mengelola database.
Peran yang diperlukan untuk mengakses hasil penelusuran
Untuk menelusuri dan melihat metadata Firestore di Knowledge Catalog, principal harus memiliki izin untuk melihat resource Firestore, termasuk izin dataplex.projects.search.
Untuk memberikan izin ini kepada principal - seperti pengguna,
grup, atau akun layanan - tetapkan peran IAM
Cloud Datastore Viewer (roles/datastore.viewer)
pada project yang berisi resource Firestore
| Operasi Knowledge Catalog | Resource Firestore | Peran atau izin yang diperlukan |
|---|---|---|
| Menelusuri resource 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 Firestore, lihat Peran dan izin Firestore.
Peran yang diperlukan untuk menelusuri entri
Untuk menelusuri entri, Anda memerlukan setidaknya salah satu peran IAM berikut di 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 terpisah 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 terhubung - seperti Firestore - untuk mengidentifikasi aset data (seperti koleksi dan database) serta mengekstrak metadata teknisnya seperti skema, deskripsi, dan lokasi ke dalam katalog Knowledge Catalog. Proses ini berjalan secara berkala untuk menjaga katalog tetap disinkronkan dengan sistem sumber.
Penelusuran kata kunci dan 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 Firestore. - Penelusuran bahasa alami (Pratinjau) menggunakan AI untuk memahami kueri semantik. Penelusuran ini memungkinkan Anda menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang kompleks. 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 kelompok koleksi Firestore
Untuk memahami proses penemuan metadata, pertimbangkan database Firestore bernama user-firestore-database. Dalam database ini, Anda memiliki skema kelompok koleksi bernama user-schema.
Setelah penemuan selesai, Anda dapat menelusuri aset ini - user-firestore-database
dan user-schema - di halaman Knowledge Catalog
Google Cloud konsol 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 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 Firestore, lihat Mengelola aspek dan memperkaya metadata.
Menelusuri aset Firestore
Gunakan halaman penelusuran Knowledge Catalog di Google Cloud konsol untuk menelusuri aset Firestore.
Buka halaman Penelusuran Knowledge Catalog.
Di panel Filter, klik Sistem, lalu pilih Firestore.
Opsional. Di Alias jenis, Anda dapat memfilter hasil penelusuran ke jenis aset 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 melakukan kueri penelusuran kata kunci. Misalnya, Anda dapat memasukkan system=Firestore AND type=Database untuk melihat semua database Firestore.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Untuk melihat semua aset Firestore, masukkan system=Firestore. Anda dapat memasukkan kata kunci tertentu. Misalnya, untuk melihat semua database Firestore:
system=Firestore AND type=Database
Anda juga dapat menggunakan tanda kurung dan operator logis AND dan OR untuk ekspresi 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 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 Firestore yang ingin Anda kueri:firestore-databasefirestore-schema
Contoh kueri mungkin 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 Aspek, klik menu Tambahkan jenis aspek lainnya.
- Masukkan
Firestore, lalu pilih satu atau beberapa jenis aspek berikut untuk membatasi hasil penelusuran ke jenis tersebut.- Database Firestore
- Skema 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 hal berikut:
- Untuk menambahkan deskripsi teks lengkap aset, di Ringkasan, klik Tambahkan .
- Untuk melampirkan aspek ke aset, di Aspek, klik Tambahkan .
- Untuk melihat database anggota untuk instance, klik tab Daftar Entri , lalu klik Tampilkan semua entri turunan dalam penelusuran.
- Di Detail entri, lihat detail lengkap aset. Klik nama entri untuk melihat entri tambahan.
Penelusuran Bahasa Alami di Firestore
Penelusuran bahasa alami (Pratinjau) menggunakan AI untuk memahami kueri semantik. Penelusuran ini memungkinkan Anda menemukan resource menggunakan bahasa sehari-hari, sehingga tidak memerlukan sintaksis yang kompleks. 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 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 Firestore.
Untuk mengetahui informasi selengkapnya, lihat Sintaksis penelusuran untuk Knowledge Catalog.
Contoh alur kerja: Melihat detail dari database ke skema
Untuk melihat detail dari database ke skema, ikuti langkah-langkah berikut:
Buka halaman Penelusuran Knowledge Catalog.
Di panel Filter, pilih Sistem, lalu Firestore. Atau, masukkan
system=Firestoredi kolom penelusuran.Pilih database.
Di halaman Detail Firestore, klik tab Daftar entri, lalu klik Tampilkan semua entri turunan dalam penelusuran.
Di halaman Detail database Firestore, klik tab Daftar entri , lalu klik Tampilkan semua entri turunan dalam penelusuran. Knowledge Catalog menampilkan grup koleksi di database.
Pilih nama kelompok koleksi, lalu di halaman Detail kelompok koleksi , klik Skema untuk melihat skema.
Opsional: Untuk menambahkan jenis aspek ke database, klik tombol Tambahkan aspek.
Harga
Tidak ada biaya untuk menyimpan metadata teknis Firestore di Knowledge Catalog. Harga Knowledge Catalog standar berlaku untuk panggilan API dan pengayaan metadata bisnis tambahan. Untuk mengetahui informasi selengkapnya, lihat halaman harga Knowledge Catalog.
Batasan
- Hasil kueri dipangkas setelah 10.000 grup koleksi di-ingest.
- Selama ingestion batch, perlu waktu hingga 48 jam agar pembaruan pada database Anda ditampilkan di Knowledge Catalog.
- Selama ingestion langsung, perlu waktu hingga 5 menit agar pembaruan pada database Anda ditampilkan di Knowledge Catalog.
- Grup koleksi tidak diperbarui selama ingestion langsung.
- Skema kelompok koleksi diperbarui selama penyerapan langsung, tetapi pembaruan ini hanya mencakup 100 kolom primitif tingkat atas pertama dalam urutan abjad. Informasi skema yang tersisa diperbarui 24 hingga 48 jam setelah ingestion langsung.
- Proses ekstraksi mungkin memerlukan waktu beberapa menit.
Langkah berikutnya
- Tentang pengelolaan katalog data di Knowledge Catalog
- Peran Identity and Access Management Knowledge Catalog