Dokumen ini menjelaskan cara membuat dan mengelola jenis aspek, dan menganotasi entri dengan aspek-aspek.
Dataplex Catalog menjelaskan entri berdasarkan serangkaian aspek. Anda dapat menjelaskan entri dengan {i>metadata <i} tambahan menggunakan aspek dan jenis aspek.
Untuk mengetahui informasi selengkapnya, lihat Ringkasan Dataplex Catalog.
Aspek
Aspect memungkinkan Anda merekam metadata dalam entri. Menambahkan aspek ke entri membantu memberikan konteks yang bermakna bagi siapa pun yang perlu menggunakan aset. Anda dapat menggunakan aspek untuk menyimpan {i>metadata <i}bisnis (misalnya, klasifikasi data) dan metadata teknis (misalnya, skema).
Aspek dianggap sebagai bagian dari sumber daya entri dan tidak terpisah Google Cloud Platform. Saat Anda memodifikasi aspek, Anda perlu memodifikasi entri yang berisi aspek tersebut.
Anda dapat menentukan aspek tingkat pemula untuk menjelaskan entri, atau di tingkat kolom untuk menggambarkan suatu kolom dalam entri.
Setiap aspek adalah instance jenis aspek. Jenis aspek menentukan template untuk aspek-aspeknya. Setiap jenis aspek berisi kumpulan kolom. Saat Anda membuat aspek tersebut, Anda harus memberikan nilai untuk {i>field<i} tersebut.
Untuk entri tertentu, bisa ada paling banyak satu aspek yang terkait dengan entri tersebut, per jenis aspek. Anda dapat memiliki beberapa aspek yang terkait dengan kolom entri per jenis aspek.
Kategori aspek
Aspek dikategorikan ke dalam sebagai berikut:
Aspek yang diperlukan: aspek yang bersifat wajib saat pembuatan entri. Aspek tersebut ditentukan oleh jenis entri dari entri tertentu. Semua entri milik tipe entri harus selalu memiliki semua aspek yang dibutuhkan yang ditentukan oleh jenis entri tersebut.
Dataplex mengelola aspek-aspek yang diperlukan (misalnya, skema) untuk entri sistem.
Perhatikan hal berikut:
Anda dapat mengaitkan aspek yang diperlukan hanya dengan entri, bukan dengan kolom entri.
Anda tidak dapat menghapus aspek yang diperlukan dari entri.
Anda dapat membaca aspek yang diperlukan dari entri sistem, tetapi tidak dapat mengubahnya.
Aspek opsional: Anda dapat mengaitkan aspek opsional dengan entri atau dengan kolom entri. Anda dapat mengisi aspek opsional pada saat masuk pembuatan, atau setelahnya dengan memperbarui entri.
Anda dapat menghapus aspek opsional setelah aspek tersebut diisi.
Jenis aspek
Jenis aspek adalah resource yang dapat digunakan kembali yang menyediakan template untuk aspek.
Kategori jenis aspek
Jenis aspek dikategorikan ke dalam berikut ini:
Jenis aspek kustom: jenis aspek yang Anda buat di Katalog Dataplex.
Jenis aspek sistem: jenis aspek yang disediakan, digunakan, dan digunakan oleh Dataplex dan mengelola.
Jenis aspek sistem dikategorikan lebih lanjut menjadi dapat digunakan kembali dan dibatasi. Tabel berikut menjelaskan kategori jenis aspek sistem, dan daftar tipe aspek yang disediakan Dataplex untuk setiap kategori:
Kategori jenis aspek sistem Deskripsi Jenis aspek yang disediakan Dataplex Jenis aspek sistem yang dapat digunakan kembali Anda dapat menggunakan jenis aspek ini untuk membuat atau memodifikasi aspek. generic
storage
Jenis aspek sistem yang dibatasi Dataplex mengelola jenis aspek ini.
Anda dapat membaca aspek menurut jenis aspek ini, tetapi tidak dapat membuat atau mengedit aspek berdasarkan jenis aspek ini.bigquery-connection
bigquery-dataset
bigquery-model
bigquery-routine
bigquery-table
bigquery-view
cloudsql-database
cloudsql-instance
cloudsql-schema
cloudsql-table
cloudsql-view
storage
sql-access
storage-bucket
storage-folder
Anda dapat membuat jenis aspek kustom di lokasi regional tertentu atau sebagai Google Cloud Platform. Jenis aspek sistem selalu bersifat global. Lokasi jenis aspek berdampak pada ruang lingkup penerapannya. Untuk informasi selengkapnya, lihat Batasan project dan lokasi.
Sebelum memulai
Sebelum Anda membuat dan mengelola jenis dan aspek aspek, selesaikan tugas yang dijelaskan di bagian ini.
Peran yang diperlukan
Untuk mendapatkan izin yang Anda perlukan untuk membuat dan mengelola jenis dan aspek aspek, minta administrator untuk memberi Anda peran IAM berikut pada resource:
-
Kumpulan izin lengkap di semua resource Dataplex Catalog, termasuk jenis aspek:
Dataplex Catalog Admin (
roles/dataplex.catalogAdmin
) -
Membuat dan mengelola semua resource Dataplex Catalog termasuk jenis aspek:
Dataplex Catalog Editor (
roles/dataplex.catalogEditor
) -
Kumpulan izin lengkap pada jenis aspek kustom (kecuali untuk izin menggunakan jenis aspek untuk membuat atau mengedit entri):
Pemilik Jenis Aspect Dataplex (
roles/dataplex.aspectTypeOwner
) -
Lihat jenis aspek dan kebijakan IAM yang terkait dengannya:
Dataplex Catalog Viewer (
roles/dataplex.catalogViewer
) -
Gunakan jenis aspek untuk membuat dan memodifikasi entri dengan aspek yang sesuai:
Pengguna Jenis Aspek Dataplex (
roles/dataplex.aspectTypeUser
) -
Tambahkan aspek dari beberapa jenis aspek sistem, seperti
schema
,overview
,contacts
: Pemilik Entri Dataplex (roles/dataplex.entryOwner
)
Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.
Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.
Untuk informasi selengkapnya, lihat Peran IAM Dataplex.
Mengaktifkan API
Aktifkan Dataplex API di project Dataplex Anda.
Membuat jenis aspek
Konsol
Di konsol Google Cloud, buka halaman Catalog Dataplex.
Klik tab Jenis aspek > Khusus.
Di bagian Details, masukkan informasi berikut:
- Opsional: Di kolom Nama tampilan, masukkan nama untuk aspek .
- Di kolom ID jenis aspek, masukkan ID unik untuk jenis aspek.
- Opsional: Di kolom Deskripsi, masukkan deskripsi untuk jenis aspek.
- Di kolom Lokasi, pilih lokasi untuk jenis aspek. Anda tidak dapat mengubah lokasi jenis aspek setelah membuatnya.
Opsional: Tentukan template untuk jenis aspek Anda.
Di Template, klik Tambahkan kolom. Di bagian Kolom baru, masukkan yang berikut:
- Di kolom Nama, masukkan nama.
- Opsional: Di kolom Nama tampilan, masukkan nama tampilan.
- Opsional: Di kolom Deskripsi, masukkan deskripsi.
Di kolom Jenis, pilih jenis data untuk kolom tersebut. Berdasarkan pilihan, kumpulan kolom dan opsi berikutnya akan ditampilkan:
Jika Anda memilih Text sebagai jenis data, ikuti langkah-langkah berikut:
- Di kolom Text type, pilih jenis teks.
- Di kolom Nilai teks, berikan petunjuk untuk teks tersebut kolom tersebut. Untuk melakukannya, klik Tambahkan nilai dan masukkan petunjuk. Anda dapat menambahkan beberapa petunjuk untuk kolom teks.
- Klik Done.
Jika Anda memilih Enum sebagai jenis data, tambahkan nilai enum:
- Klik Add an enum value.
- Di kolom Value, masukkan nilai enum. Anda dapat menambahkan beberapa nilai enum.
- Klik Done.
Jika Anda memilih Array sebagai jenis data, di Item array tentukan jenis item yang akan ada dalam array:
- Klik Tambahkan item array.
- Di kolom Nama, masukkan nama untuk item array.
- Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk item array.
- Opsional: Di kolom Deskripsi, masukkan deskripsi untuk item array.
Di kolom Jenis, pilih jenis data untuk item array.
Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya yang ditampilkan. Mereka mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Rekam di tempat lain pada bagian ini.
Klik Done.
Jika Anda memilih Peta sebagai jenis data, di Nilai peta tentukan jenis nilai yang akan ditampilkan di peta:
- Klik Add map value.
- Di kolom Nama, masukkan nama untuk peta.
- Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk peta.
- Opsional: Di kolom Deskripsi, masukkan deskripsi untuk peta.
Di kolom Type, pilih jenis data untuk peta.
Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya yang ditampilkan. Mereka mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Rekam di tempat lain pada bagian ini.
Klik Done.
Jika Anda memilih Record sebagai jenis data, masukkan berikut ini:
- Di kolom Record ID, masukkan ID unik yang dicatat lain yang dapat digunakan untuk merujuk pada data ini. Lihat Contoh untuk menggunakan kolom referensi Data dan ID Kumpulan Data dari dokumen ini.
- Opsional: Jika Anda ingin menambahkan referensi ke data lain dari template ini, gunakan kolom Referensi catatan. Anda tidak bisa ubah ini setelah Anda membuat jenis aspek. Lihat Contoh untuk menggunakan kolom referensi Data dan ID Kumpulan Data dari dokumen ini.
Di bagian Record fields, Anda dapat menentukan objek yang kompleks dengan beberapa {i>field <i}bersarang (nested). Untuk melakukannya, klik Tambahkan item kolom data, lalu tentukan hal berikut:
- Di kolom Name, masukkan nama untuk kolom data.
- Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk isian {i>record<i}.
- Opsional: Di kolom Deskripsi, masukkan deskripsi untuk isian {i>record<i}.
Di kolom Jenis, pilih jenis data.
Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya yang ditampilkan. Mereka mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Rekam di awal bagian ini.
Klik Done.
Untuk membuat bidang wajib diisi untuk aspek jenis ini, pilih Wajib diisi. Untuk informasi lebih lanjut tentang aspek yang dibutuhkan dan aspek opsional, lihat kategori aspek dari dokumen ini.
Klik Done.
Untuk menambahkan beberapa kolom, klik Tambahkan kolom, lalu ulangi langkah sebelumnya langkah.
Opsional: Di bagian Label, tambahkan label arbitrer sebagai nilai kunci ke resource Anda:
- Klik Tambahkan label.
- Di kolom Kunci, masukkan kunci.
- Di kolom Nilai, masukkan nilai untuk kunci.
- Untuk menambahkan label lainnya, klik Tambahkan label dan ulangi langkah tersebut.
Klik Simpan.
Setelah membuat jenis aspek, Anda dapat menambahkan aspek ke entri.
REST
Untuk membuat jenis aspek baru, gunakan
aspectType.create
.
Contoh penggunaan kolom ID Kumpulan Data dan referensi Kumpulan data
Anda dapat menggunakan kolom ID Kumpulan Data dan Referensi catatan untuk metode rekursif referensi. Contoh berikut menunjukkan cara menggunakan kolom ini:
Pertimbangkan jenis aspek yang disebut Employee
, dengan kolom berikut:
- Nama (jenis:
Text
) - Tanggal mulai (jenis:
Date & time
) - Nama (jenis:
Text
) - Alamat saat ini (jenis:
Record
) - Alamat tetap (jenis:
Record
)
Dua bidang alamat, Current address dan Permanent address adalah,
jenis data yang sama Record
. Untuk menghindari duplikasi, Anda dapat menetapkan ID Kumpulan Data
dan Rekam referensi saat menentukan kolom ini.
Saat menentukan kolom Current address, Anda dapat menentukan Record ID sebagai
address-field
. Untuk Alamat permanen, Anda dapat menentukan nilai yang sama
(address-field
) untuk Referensi data. Contoh:
- Nama (jenis:
Text
) - Tanggal mulai (jenis:
Date & time
) - Nama (jenis:
Text
) - Alamat saat ini (jenis:
Record
, ID Kumpulan Data:address-field
) - Alamat permanen (jenis:
Record
, Referensi catatan:address-field
)
Dengan demikian, Anda tidak perlu menduplikasi {i>field<i} dari alamat lain.
Menambahkan aspek ke entri
Setelah membuat jenis aspek, Anda dapat membuat aspek dari jenis tersebut. Untuk menambahkan aspek ke entri, Anda harus memperbarui entri tersebut, karena aspek disimpan dalam entri.
Perhatikan hal berikut:
- Anda dapat menambahkan aspek-aspek pada entri atau kolom entri.
- Anda dapat mengedit aspek yang diperlukan hanya untuk entri kustom. Anda tidak bisa menghapus aspek yang diperlukan.
Anda dapat mengedit dan menghapus aspek opsional untuk entri khusus dan entri sistem.
Konsol
Di konsol Google Cloud, buka halaman Penelusuran Dataplex.
Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.
Cari entri yang ingin Anda tambahi aspek, dan klik entri tersebut.
Halaman detail entri akan terbuka.
Untuk menambahkan aspek ke entri, ikuti langkah-langkah berikut:
- Di halaman detail entri, klik tab Details.
- Untuk menambahkan aspek wajib
atau aspek opsional ke entri,
di bagian Aspek, klik
Anda tidak dapat menambahkan aspek yang diperlukan jika jenis entri kolom yang dipilih entri tidak memiliki aspek yang perlu ditentukan.
Tambahkan untuk masing-masing
kategori. - Telusuri dan pilih aspek yang ingin Anda tambahkan.
- Di jendela Tambahkan aspek, masukkan nilai untuk kolom.
- Klik Simpan.
Untuk menambahkan aspek ke kolom entri, ikuti langkah-langkah berikut:
- Di halaman detail entri, klik tab Schema.
- Pilih kolom yang ingin Anda tambahi aspek.
- Klik Tambahkan aspek.
- Telusuri dan pilih aspek yang ingin Anda tambahkan.
- Di jendela Tambahkan aspek, masukkan nilai untuk kolom.
- Klik Simpan.
REST
Untuk menambahkan aspek ke entri atau kolom entri, gunakan metode
entry.patch
.
Membuat dan menggunakan aspek dalam entri dengan jenis aspek masing-masing dan entri data yang berada di organisasi Google Cloud lain, tidak didukung.
Mengelola aspek yang ada untuk entri
Bagian ini menjelaskan cara memperbarui dan menghapus aspek yang ada untuk entri.
Memperbarui aspek
Anda dapat mengedit aspek opsional untuk entri kustom dan entri sistem. Anda dapat mengedit aspek yang diperlukan hanya untuk entri kustom.
Konsol
Di konsol Google Cloud, buka halaman Penelusuran Dataplex.
Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.
Cari entri yang aspeknya ingin Anda perbarui, dan klik entri tersebut.
Halaman detail entri akan terbuka.
Klik tab Detail.
Untuk aspek yang ingin Anda perbarui, klik
Edit.Di jendela Edit aspek, perbarui kolom yang wajib diisi.
Klik Simpan.
REST
Untuk memperbarui aspek entri atau kolom entri, gunakan metode
entry.update
.
Menghapus aspek
Konsol
Di konsol Google Cloud, buka halaman Penelusuran Dataplex.
Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.
Cari entri yang aspeknya ingin Anda hapus, dan klik entri tersebut.
Halaman detail entri akan terbuka.
Klik tab Detail.
Untuk aspek yang ingin Anda hapus, klik
Hapus.Klik Confirm.
REST
Untuk menghapus aspek entri, gunakan metode
entry.update
.
Kelola jenis aspek
Bagian ini menjelaskan cara melihat, memperbarui, dan menghapus jenis aspek.
Lihat daftar jenis aspek yang tersedia
Konsol
Di konsol Google Cloud, buka halaman Catalog Dataplex.
Klik tab Jenis aspek.
Anda dapat mengakses daftar jenis aspek kustom dan sistem. Untuk selengkapnya informasi lainnya, lihat kategori jenis aspek dari dokumen ini.
Di tab Kustom, jenis aspek dengan akhiran
(Data Catalog)
adalah template tag yang dimigrasikan dari Data Catalog.Untuk melihat daftar jenis aspek di semua project, klik Tab Kustom, lalu klik tombol Tampilkan dari semua project untuk posisi nyala.
REST
Untuk mencantumkan semua jenis aspek yang tersedia, gunakan
aspectTypes.list
.
Melihat detail jenis aspek
Konsol
Di konsol Google Cloud, buka halaman Catalog Dataplex.
Klik tab Jenis aspek.
Klik jenis aspek.
Halaman detail jenis aspek akan terbuka. Anda dapat melihat informasi seperti nama tampilan, ID jenis aspek, deskripsi, ID project, lokasi, label, tanggal pembuatan, dan tanggal terakhir diubah dari jenis aspek yang dipilih.
Untuk melihat struktur jenis aspek yang dipilih, klik Template.
Untuk melihat daftar 10 entri terkait yang dibuat baru-baru ini, Klik tab Sample entries.
Untuk menelusuri semua entri terkait, klik Tampilkan semua entri terkait di Penelusuran. Tombol ini hanya muncul jika setidaknya ada satu entri terkait.
REST
Untuk mendapatkan detail jenis aspek, gunakan
aspectTypes.get
.
Memperbarui jenis aspek
Anda dapat memperbarui nama tampilan, deskripsi, kolom template, dan label dari jenis aspek. Anda tidak dapat menghapus kolom yang sudah ada di template.
Anda tidak dapat memperbarui ID jenis aspek dan lokasi setelah membuat jenis aspek.
Konsol
Di konsol Google Cloud, buka halaman Catalog Dataplex.
Klik tab Jenis aspek.
Klik jenis aspek yang ingin Anda perbarui.
Di halaman Detail jenis aspek, klik Edit.
Edit nama tampilan, deskripsi, kolom template, dan label, secara permanen sesuai kebutuhan.
Opsional: Untuk menandai kolom dalam jenis aspek sebagai tidak digunakan lagi, ikuti langkah-langkah berikut:
- Di bagian Template, luaskan kolomnya.
- Pilih Is Deprecated.
- Di kolom Alasan penghentian penggunaan, masukkan alasan untuk menghentikan penggunaan kolom yang dipilih.
- Klik Done.
Klik Simpan.
REST
Untuk memperbarui jenis aspek yang ada, gunakan
aspectTypes.patch
.
Menghapus jenis aspek
Konsol
Di konsol Google Cloud, buka halaman Catalog Dataplex.
Klik tab Jenis aspek.
Klik jenis aspek yang ingin dihapus.
Di halaman Detail jenis aspek, klik Hapus. Konfirmasi kapan diminta.
REST
Untuk menghapus jenis aspek yang ada, gunakan
aspectTypes.delete
.
Langkah selanjutnya
- Pelajari cara menelusuri aset data di Dataplex Catalog.
- Pelajari cara mengelola entri dan menyerap sumber kustom.
- Pelajari cara mengimpor metadata ke Dataplex.
- Pelajari Dataplex Catalog lebih lanjut.