Mengelola aspek dan memperkaya metadata

Dokumen ini menjelaskan cara membuat dan mengelola jenis aspek, serta menambahkan anotasi pada entri dengan aspek.

Katalog Dataplex menjelaskan entri berdasarkan serangkaian aspek. Anda dapat mendeskripsikan entri dengan metadata tambahan menggunakan aspek dan jenis aspek.

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Katalog Dataplex.

Aspek

Aspek memungkinkan Anda mengambil metadata dalam entri. Menambahkan aspek ke entri membantu memberikan konteks yang bermakna kepada siapa saja yang perlu menggunakan aset. Anda dapat menggunakan aspek untuk menyimpan metadata bisnis (misalnya, klasifikasi data) dan metadata teknis (misalnya, skema).

Aspek dianggap sebagai bagian dari resource entri, bukan resource terpisah. Saat Anda mengubah aspek, Anda juga akan mengubah entri yang berisi aspek tersebut.

Anda dapat menentukan aspek di tingkat entri untuk mendeskripsikan entri, atau di tingkat kolom untuk mendeskripsikan kolom dalam entri.

Setiap aspek adalah instance dari jenis aspek. Jenis aspek menentukan template untuk aspeknya. Setiap jenis aspek berisi sekumpulan kolom. Saat membuat aspek, Anda harus memberikan nilai untuk kolom tersebut.

Untuk entri tertentu, maksimal ada 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 hal berikut:

  • Aspek yang diperlukan: aspek yang wajib diisi saat membuat entri. Aspek tersebut ditentukan oleh jenis entri dari entri tertentu. Semua entri yang termasuk dalam jenis entri harus selalu memiliki semua aspek yang diperlukan yang ditentukan oleh jenis entri tersebut.

    Dataplex mengelola 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 pembuatan entri, atau nanti dengan memperbarui entri.

    Anda dapat menghapus aspek opsional setelah diisi.

Jenis aspek

Jenis aspek adalah resource yang dapat digunakan kembali yang menyediakan template untuk aspek.

Kategori jenis aspek

Jenis aspek dikategorikan sebagai berikut:

  • Jenis aspek kustom: jenis aspek yang Anda buat di Katalog Dataplex.

  • Jenis aspek sistem: jenis aspek yang disediakan, digunakan, dan dikelola Dataplex.

    Jenis aspek sistem selanjutnya dikategorikan menjadi dapat digunakan kembali dan dibatasi. Tabel berikut menjelaskan kategori jenis aspek sistem, dan daftar jenis 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 mengubah aspek.
    • generic
    • storage
    Jenis aspek sistem yang dibatasi Dataplex mengelola jenis aspek ini.
    Anda dapat membaca aspek berdasarkan 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 resource global. Jenis aspek sistem selalu bersifat global. Lokasi jenis aspek memengaruhi cakupan penerapannya. Untuk informasi selengkapnya, lihat Batasan project dan lokasi.

Sebelum memulai

Sebelum membuat dan mengelola jenis aspek dan aspek, selesaikan tugas-tugas yang dijelaskan di bagian ini.

Peran yang diperlukan

Untuk mendapatkan izin yang diperlukan untuk membuat dan mengelola jenis dan aspek, minta administrator untuk memberi Anda peran IAM berikut pada resource:

  • Kumpulan lengkap izin 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 lengkap izin pada jenis aspek kustom (kecuali izin untuk menggunakan jenis aspek guna membuat atau mengedit entri): Pemilik Jenis Aspek Dataplex (roles/dataplex.aspectTypeOwner)
  • Melihat jenis aspek dan kebijakan IAM yang terkait dengannya: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
  • Gunakan jenis aspek untuk membuat dan mengubah 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 mengetahui informasi selengkapnya, lihat Peran IAM Dataplex.

Mengaktifkan API

Aktifkan Dataplex API di project Dataplex Anda.

Mengaktifkan API

Membuat jenis aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Katalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek > Kustom.

  3. Di bagian Details, masukkan data berikut:

    1. Opsional: Di kolom Nama tampilan, masukkan nama untuk jenis aspek.
    2. Di kolom Aspect type ID, masukkan ID unik untuk jenis aspek.
    3. Opsional: Di kolom Deskripsi, masukkan deskripsi untuk jenis aspek.
    4. Di kolom Location, pilih lokasi untuk jenis aspek. Anda tidak dapat mengubah lokasi jenis aspek setelah membuatnya.

  4. Opsional: Tentukan template untuk jenis aspek Anda.

    Di Templates, klik Add field. Di bagian New field, masukkan hal berikut:

    1. Di kolom Name, masukkan nama.
    2. Opsional: Di kolom Nama tampilan, masukkan nama tampilan.
    3. Opsional: Di kolom Deskripsi, masukkan deskripsi.

    4. Di kolom Type, pilih jenis data untuk kolom. Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya akan ditampilkan:

      • Jika Anda memilih Teks sebagai jenis data, ikuti langkah-langkah berikut:

        1. Di kolom Jenis teks, pilih jenis teks.
        2. Di kolom Text values, berikan petunjuk untuk kolom teks. Untuk melakukannya, klik Tambahkan nilai, lalu masukkan petunjuk. Anda dapat menambahkan beberapa petunjuk untuk kolom teks.
        3. Klik Done.

      • Jika Anda memilih Enum sebagai jenis data, tambahkan nilai enum:

        1. Klik Tambahkan nilai enum.
        2. Di kolom Value, masukkan nilai enum. Anda dapat menambahkan beberapa nilai enum.
        3. Klik Done.

      • Jika Anda memilih Array sebagai jenis data, di bagian Item array, tentukan jenis item yang akan ada dalam array:

        1. Klik Tambahkan item array.
        2. Di kolom Name, masukkan nama untuk item array.
        3. Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk item array.
        4. Opsional: Di kolom Description, masukkan deskripsi untuk item array.

        5. Di kolom Type, pilih jenis data untuk item array.

          Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya akan ditampilkan. Opsi ini mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Record di bagian lain di bagian ini.

        6. Klik Done.

      • Jika Anda memilih Peta sebagai jenis data, di bagian Nilai peta, tentukan jenis nilai yang akan ada di peta:

        1. Klik Tambahkan nilai peta.
        2. Di kolom Name, masukkan nama untuk peta.
        3. Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk peta.
        4. Opsional: Di kolom Deskripsi, masukkan deskripsi untuk peta.

        5. Di kolom Type, pilih jenis data untuk peta.

          Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya akan ditampilkan. Opsi ini mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Record di bagian lain di bagian ini.

        6. Klik Done.

      • Jika Anda memilih Data sebagai jenis data, masukkan hal berikut:

        1. Di kolom Record ID, masukkan ID unik yang dapat digunakan kolom kumpulan data lain untuk merujuk ke kumpulan data ini. Lihat bagian Contoh penggunaan kolom ID Data dan Referensi data dalam dokumen ini.
        2. Opsional: Jika Anda ingin menambahkan referensi ke data lain dari template ini, gunakan kolom Referensi data. Anda tidak dapat mengubahnya setelah membuat jenis aspek. Lihat bagian Contoh penggunaan kolom ID Data dan Referensi data dalam dokumen ini.

        3. Di bagian Kolom data, Anda dapat menentukan objek kompleks dengan beberapa kolom bertingkat. Untuk melakukannya, klik Tambahkan item kolom data, lalu tentukan hal berikut:

        4. Di kolom Name, masukkan nama untuk kolom data.

        5. Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk kolom data.

        6. Opsional: Di kolom Description, masukkan deskripsi untuk kolom data.

        7. Di kolom Type, pilih jenis data.

          Berdasarkan pilihan Anda, kumpulan kolom dan opsi berikutnya akan ditampilkan. Opsi ini mirip dengan opsi yang dijelaskan untuk jenis data Text, Enum, Map, Array, dan Record sebelumnya di bagian ini.

        8. Klik Done.

    5. Untuk membuat kolom wajib diisi untuk aspek jenis ini, pilih Wajib diisi. Untuk informasi selengkapnya tentang aspek yang diperlukan dan aspek opsional, lihat bagian kategori aspek dalam dokumen ini.

    6. Klik Done.

    7. Untuk menambahkan beberapa kolom, klik Tambahkan kolom dan ulangi langkah-langkah sebelumnya.

  5. Opsional: Di bagian Labels, tambahkan label arbitrer sebagai key-value pair ke resource Anda:

    1. Klik Tambahkan label.
    2. Di kolom Key, masukkan kunci.
    3. Di kolom Value, masukkan nilai untuk kunci.
    4. Untuk menambahkan label lainnya, klik Tambahkan label, lalu ulangi langkah-langkahnya.

  6. Klik Simpan.

gcloud

Untuk membuat jenis aspek, gunakan perintah gcloud dataplex aspect-types create.

REST

Untuk membuat jenis aspek, gunakan metode aspectType.create.

Setelah membuat jenis aspek, Anda dapat menambahkan aspek ke entri.

Contoh penggunaan kolom ID Data dan Referensi data

Anda dapat menggunakan kolom ID Data dan Referensi data untuk referensi rekursif. Contoh berikut menunjukkan cara menggunakan kolom ini:

Pertimbangkan jenis aspek yang disebut Employee, dengan kolom berikut:

  • Nama (jenis:Text)
  • Tanggal mulai (jenis:Date & time)
  • Designation (type:Text)
  • Alamat saat ini (jenis:Record)
  • Alamat tetap (jenis:Record)

Dua kolom alamat Current address dan Permanent address memiliki jenis data yang sama, yaitu Record. Untuk menghindari duplikasi, Anda dapat menetapkan nilai ID Data dan Referensi data 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)
  • Designation (type:Text)
  • Alamat saat ini (jenis:Record, ID Data:address-field)
  • Alamat tetap (jenis:Record, Referensi data:address-field)

Dengan begitu, Anda tidak perlu menduplikasi kolom 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, karena aspek disimpan dalam entri.

Perhatikan hal berikut:

  • Anda dapat menambahkan aspek ke entri atau ke kolom entri.
  • Anda dapat mengedit aspek yang diperlukan hanya untuk entri kustom. Anda tidak dapat menghapus aspek yang diperlukan.

  • Anda dapat mengedit dan menghapus aspek opsional untuk entri kustom dan entri sistem.

Konsol

  1. Di konsol Google Cloud, buka halaman Penelusuran Dataplex.

    Buka Penelusuran

  2. Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.

  3. Telusuri entri yang ingin Anda tambahkan aspek, lalu klik entri tersebut. Halaman detail entri akan terbuka.

  4. Untuk menambahkan aspek ke entri, ikuti langkah-langkah berikut:

    1. Klik tab Detail.
    2. Untuk menambahkan aspek wajib atau aspek opsional ke entri, di bagian Aspek, klik Tambahkan untuk kategori masing-masing.
      Anda tidak dapat menambahkan aspek yang diperlukan jika jenis entri dari entri yang dipilih tidak memiliki aspek yang diperlukan.
    3. Telusuri dan pilih aspek yang ingin ditambahkan.
    4. Di jendela Add aspect, masukkan nilai untuk kolom.
    5. Klik Simpan.

  5. Untuk menambahkan aspek ke kolom entri, ikuti langkah-langkah berikut:

    1. Di halaman detail entri, klik tab Schema.
    2. Pilih kolom yang ingin Anda tambahkan aspek.
    3. Klik Tambahkan aspek.
    4. Telusuri dan pilih aspek yang ingin ditambahkan.
    5. Di jendela Add aspect, masukkan nilai untuk kolom.
    6. Klik Simpan.

gcloud

Untuk menambahkan aspek ke entri atau ke kolom entri, gunakan perintah gcloud dataplex entries update.

REST

Untuk menambahkan aspek ke entri atau ke kolom entri, gunakan metode entry.patch.

Membuat dan menggunakan aspek dalam entri dengan jenis aspek dan entri masing-masing berada di organisasi Google Cloud yang berbeda 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

  1. Di konsol Google Cloud, buka halaman Penelusuran Dataplex.

    Buka Penelusuran

  2. Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.

  3. Telusuri entri yang aspeknya ingin Anda perbarui, lalu klik entri tersebut.

    Halaman detail entri akan terbuka.

  4. Klik tab Detail.

  5. Untuk aspek yang ingin diperbarui, klik Edit.

  6. Di jendela Edit aspect, perbarui kolom yang wajib diisi.

  7. Klik Simpan.

gcloud

Untuk memperbarui aspek entri atau kolom entri, gunakan perintah gcloud dataplex entries update.

REST

Untuk memperbarui aspek entri atau kolom entri, gunakan metode entry.update.

Menghapus aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Penelusuran Dataplex.

    Buka Penelusuran

  2. Untuk Choose search platform, pilih Dataplex Catalog sebagai mode penelusuran.

  3. Telusuri entri yang aspeknya ingin Anda hapus, lalu klik entri tersebut.

    Halaman detail entri akan terbuka.

  4. Klik tab Detail.

  5. Untuk aspek yang ingin dihapus, klik Hapus.

  6. Klik Konfirmasi.

gcloud

Untuk menghapus aspek entri, gunakan perintah gcloud dataplex entries update.

REST

Untuk menghapus aspek untuk entri, gunakan metode entry.update.

Mengelola jenis aspek

Bagian ini menjelaskan cara melihat, memperbarui, dan menghapus jenis aspek.

Melihat daftar jenis aspek yang tersedia

Konsol

  1. Di konsol Google Cloud, buka halaman Katalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek.

    Anda dapat mengakses daftar jenis aspek kustom dan sistem. Untuk mengetahui informasi selengkapnya, lihat bagian kategori jenis aspek dalam dokumen ini.

    Di tab Kustom, jenis aspek dengan akhiran (Data Catalog) adalah template tag yang dimigrasikan dari Data Catalog.

  3. Untuk melihat daftar jenis aspek di semua project, klik tab Custom, lalu klik tombol Show from all projects ke posisi aktif.

gcloud

Untuk mencantumkan semua jenis aspek yang tersedia, gunakan perintah gcloud dataplex aspect-types list.

REST

Untuk mencantumkan semua jenis aspek yang tersedia, gunakan metode aspectTypes.list.

Melihat detail jenis aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Katalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek.

  3. Klik jenis aspek.

    Halaman detail jenis aspek akan terbuka. Anda dapat melihat informasi seperti nama tampilan, ID jenis aspek, deskripsi, project ID, lokasi, label, tanggal pembuatan, dan tanggal terakhir diubah dari jenis aspek yang dipilih.

  4. Untuk melihat struktur jenis aspek yang dipilih, klik tab Template.

  5. Untuk melihat daftar 10 entri terkait yang dibuat baru-baru ini, klik tab Contoh entri.

  6. Untuk menelusuri semua entri terkait, klik Tampilkan semua entri terkait di Penelusuran. Tombol ini hanya muncul jika ada minimal satu entri terkait.

gcloud

Untuk mendapatkan detail jenis aspek, gunakan perintah gcloud dataplex aspect-types describe.

REST

Untuk mendapatkan detail jenis aspek, gunakan metode aspectTypes.get.

Memperbarui jenis aspek

Anda dapat memperbarui nama tampilan, deskripsi, kolom template, dan label jenis aspek. Anda tidak dapat menghapus kolom yang ada dalam template.

Anda tidak dapat memperbarui ID dan lokasi jenis aspek setelah membuat jenis aspek.

Konsol

  1. Di konsol Google Cloud, buka halaman Katalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek.

  3. Klik jenis aspek yang ingin Anda perbarui.

  4. Di halaman Detail jenis aspek, klik Edit.

  5. Edit nama tampilan, deskripsi, kolom template, dan label, sesuai kebutuhan.

  6. Opsional: Untuk menandai kolom dalam jenis aspek sebagai tidak digunakan lagi, ikuti langkah-langkah berikut:

    1. Di bagian Template, luaskan kolom.
    2. Pilih Tidak Digunakan Lagi.
    3. Di kolom Alasan penghentian, masukkan alasan penghentian kolom yang dipilih.
    4. Klik Done.

  7. Klik Save.

gcloud

Untuk memperbarui jenis aspek, gunakan perintah gcloud dataplex aspect-types update.

REST

Untuk memperbarui jenis aspek, gunakan metode aspectTypes.patch.

Menghapus jenis aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Katalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek.

  3. Klik jenis aspek yang ingin dihapus.

  4. Di halaman Detail jenis aspek, klik Hapus. Konfirmasi saat diminta.

gcloud

Untuk menghapus jenis aspek, gunakan perintah gcloud dataplex aspect-types delete.

REST

Untuk menghapus jenis aspek yang ada, gunakan metode aspectTypes.delete.

Langkah selanjutnya