Mengelola aspek dan memperkaya metadata

Dokumen ini menjelaskan cara membuat dan mengelola jenis aspek, serta menganotasi entri dengan aspek.

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Dataplex Catalog.

Aspek

Aspect memungkinkan Anda merekam metadata dalam entri. Penambahan aspek ke entri akan membantu memberikan konteks yang bermakna bagi 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 dan bukan resource terpisah. Saat Anda memodifikasi aspek, Anda juga perlu memodifikasi entri yang berisi aspek tersebut.

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

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

Untuk entri tertentu, mungkin ada maksimal satu aspek yang terkait dengan entri, 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 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-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 baik pada saat pembuatan entri, atau pada lain waktu 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 Dataplex Catalog.

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

    Jenis aspek sistem dikategorikan lebih lanjut 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 memodifikasi 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 pada 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

    Jangan gunakan jenis aspek sistem overview, contacts, dan schema.

    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 mengetahui 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 diperlukan untuk membuat serta 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 lengkap izin pada jenis aspek kustom (kecuali izin penggunaan jenis aspek untuk membuat atau mengedit entri): Dataplex Aspect Type Owner (roles/dataplex.aspectTypeOwner)
  • Melihat jenis aspek dan kebijakan IAM yang terkait: Dataplex Catalog Viewer (roles/dataplex.catalogViewer)
  • Gunakan jenis aspek untuk membuat dan mengubah entri dengan aspek yang sesuai: Dataplex Aspect Type User (roles/dataplex.aspectTypeUser)
  • Tambahkan aspek dari beberapa jenis aspek sistem, seperti schema, overview, contacts: Dataplex Entry Owner (roles/dataplex.entryOwner)

Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses.

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 Catalog Dataplex.

    Buka Katalog

  2. Klik tab Jenis aspek > Khusus.

  3. Di bagian Detail, masukkan informasi berikut:

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

  4. Opsional: Tentukan template untuk jenis aspek Anda.

    Di Template, klik Tambahkan kolom. Di bagian Kolom baru, masukkan informasi berikut:

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

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

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

        1. Di kolom Text type, pilih jenis teks.
        2. Di kolom Nilai teks, berikan petunjuk untuk kolom teks. Untuk melakukannya, klik Tambahkan nilai dan 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 Add an enum value.
        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 Nama, 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 Jenis, 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 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 Add map value.
        2. Di kolom Nama, 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 ini.

        6. Klik Done.

      • Jika Anda memilih Record sebagai jenis data, masukkan berikut ini:

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

        3. Di bagian Record fields, Anda dapat menentukan objek kompleks dengan beberapa kolom bertingkat. Untuk melakukannya, klik Add record field item, dan tentukan hal berikut:

          1. Di kolom Name, masukkan nama untuk kolom data.
          2. Opsional: Di kolom Nama tampilan, masukkan nama tampilan untuk kolom data.
          3. Opsional: Di kolom Description, masukkan deskripsi untuk kolom data.

          4. Di kolom Jenis, 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.

        4. Klik Done.

    5. Untuk membuat kolom wajib diisi untuk aspek jenis ini, pilih Is required. 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 Add field dan ulangi langkah-langkah sebelumnya.

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

    1. Klik Tambahkan label.
    2. Di kolom Kunci, masukkan kunci.
    3. Di kolom Nilai, masukkan nilai untuk kunci.
    4. Untuk menambahkan label lainnya, klik Tambahkan label dan ulangi langkah tersebut.

  6. Klik Save.

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

REST

Untuk membuat jenis aspek baru, gunakan metode aspectType.create.

Contoh penggunaan kolom ID Kumpulan Data dan referensi Kumpulan data

Anda dapat menggunakan kolom Record ID dan Record reference 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)
  • Nama (jenis:Text)
  • Alamat saat ini (jenis:Record)
  • Alamat tetap (jenis:Record)

Kedua kolom alamat, Current address dan Permanent address, memiliki jenis data yang sama, Record. Untuk menghindari duplikasi, Anda dapat menetapkan nilai Record ID dan Record reference 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, karena aspek disimpan dalam entri.

Perhatikan hal-hal berikut:

  • Anda dapat menambahkan aspek-aspek pada entri atau 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. Cari entri yang ingin Anda tambahi aspek, lalu klik entri tersebut.

    Halaman detail entri akan terbuka.

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

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

  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 tambahi aspek.
    3. Klik Tambahkan aspek.
    4. Telusuri dan pilih aspek yang ingin Anda tambahkan.
    5. Di jendela Tambahkan aspek, masukkan nilai untuk kolom.
    6. Klik Save.

REST

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

Membuat dan menggunakan aspek dalam entri tidak didukung jika jenis aspek dan entrinya berada di organisasi Google Cloud yang berbeda.

Mengelola aspek yang ada untuk entri

Bagian ini menjelaskan cara mengupdate dan menghapus aspek yang sudah 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. Cari entri yang aspeknya ingin diperbarui, lalu klik entri tersebut.

    Halaman detail entri akan terbuka.

  4. Klik tab Details.

  5. Untuk aspek yang ingin Anda perbarui, klik Edit.

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

  7. Klik Save.

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 Details.

  5. Untuk aspek yang ingin Anda hapus, klik Delete.

  6. 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

  1. Di konsol Google Cloud, buka halaman Catalog 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 Custom, 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.

REST

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

Melihat detail jenis aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Catalog 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 Sample entries.

  6. Untuk menelusuri semua entri terkait, klik Show all related entries in Search. Tombol ini hanya muncul jika ada setidaknya satu entri terkait.

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 sudah ada di template.

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

Konsol

  1. Di konsol Google Cloud, buka halaman Catalog 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 kolomnya.
    2. Pilih Is Deprecated.
    3. Di kolom Alasan penghentian penggunaan, masukkan alasan untuk menghentikan penggunaan kolom yang dipilih.
    4. Klik Done.

  7. Klik Save.

REST

Untuk memperbarui jenis aspek yang ada, gunakan metode aspectTypes.patch.

Menghapus jenis aspek

Konsol

  1. Di konsol Google Cloud, buka halaman Catalog 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.

REST

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

Langkah selanjutnya