Mengekspor link entri ke Google Spreadsheet

Dokumen ini menjelaskan cara menggunakan utilitas ekspor link entri untuk mengekstrak link entri (hubungan antara istilah glosarium dan aset data) dari Knowledge Catalog (sebelumnya Dataplex Universal Catalog) ke Google Spreadsheet.

Anda dapat mengekspor link entri ke Google Spreadsheet untuk mengaudit link yang ada, mencadangkan metadata, atau menyiapkan template untuk update massal.

Sebelum memulai

Sebelum mengekspor link entri ke Google Spreadsheet, selesaikan prasyarat berikut.

Menyiapkan akun layanan

Untuk menjalankan utilitas ekspor, Anda harus menyiapkan akun layanan dengan izin yang diperlukan untuk mengakses Google Sheets API dan meniru kredensial pengguna Anda:

  1. Identifikasi atau buat akun layanan.

    Pilih akun layanan yang ada atau buat akun layanan baru di project tempat Anda menjalankan utilitas impor. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan. Perhatikan email akun layanan (misalnya, SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com).

  2. Konfigurasi peniruan akun layanan.

    Untuk menjalankan skrip utilitas ekspor secara lokal, akun pengguna Anda harus memiliki izin untuk meniru akun layanan. Beri akun pengguna Anda peran Service Account Token Creator (roles/iam.serviceAccountTokenCreator) di akun layanan.

    Untuk mengetahui informasi selengkapnya, lihat Mengelola akses ke akun layanan.

  3. Beri akun layanan akses Editor ke Google Spreadsheet.

    Buka Google Spreadsheet yang ingin Anda gunakan untuk proses impor, klik Share, lalu tambahkan email akun layanan sebagai Editor. Izin ini memungkinkan akun layanan membaca dari atau menulis data ke spreadsheet Anda.

Peran yang diperlukan

Untuk memastikan akun layanan memiliki izin yang diperlukan untuk mengekspor link entri ke Google Spreadsheet, minta administrator Anda untuk memberikan peran IAM berikut ke akun layanan:

Untuk mengetahui informasi selengkapnya tentang pemberian peran, lihat Mengelola akses ke project, folder, dan organisasi.

Administrator Anda mungkin juga dapat memberikan izin yang diperlukan kepada akun layanan melalui peran kustom atau peran yang telah ditetapkan.

Mengaktifkan API

Untuk mengekspor link entri, aktifkan API berikut di project Anda:

Peran yang diperlukan untuk mengaktifkan API

Untuk mengaktifkan API, Anda memerlukan peran IAM Service Usage Admin (roles/serviceusage.serviceUsageAdmin), yang berisi izin serviceusage.services.enable. Pelajari cara memberikan peran.

Aktifkan API

Menyiapkan repositori git

Clone repositori dataplex-labs:

git clone https://github.com/GoogleCloudPlatform/dataplex-labs.git
cd dataplex-labs/dataplex-quickstart-labs/00-resources/scripts/python/business-glossary-import/dataplex-glossary/export

Menginstal dependensi

Instal dependensi Python yang diperlukan:

pip3 install -r requirements.txt
cd dataplex-glossary

Jika Anda mengalami masalah dengan penginstalan paket, siapkan lingkungan pengembangan Python baru.

Mengautentikasi dan mengonfigurasi peniruan akun layanan

Inisialisasi Google Cloud CLI dan autentikasi menggunakan Kredensial Default Aplikasi (ADC) dengan peniruan akun layanan:

# Set your service account email address
SA_EMAIL="SERVICE_ACCOUNT_EMAIL"

# Authenticate ADC using service account impersonation and required scopes
gcloud init
gcloud auth login
gcloud auth application-default login \
  --impersonate-service-account="${SA_EMAIL}" \
  --scopes="https://www.googleapis.com/auth/spreadsheets"

Ganti SERVICE_ACCOUNT_EMAIL dengan ID email akun layanan. Contoh:

SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Menyiapkan Google Spreadsheet target untuk ekspor

Buat Google Spreadsheet kosong atau gunakan yang sudah ada. Skrip ekspor akan menulis ke spreadsheet pertama. Pastikan Anda telah memberikan akses Editor akun layanan ke Google Spreadsheet.

Menyiapkan variabel lingkungan

Siapkan variabel lingkungan berikut:

# Set your glossary URL
export GLOSSARY_URL="GLOSSARY_URL"

# Set your Google Sheet URL
export SPREADSHEET_URL="GOOGLE_SHEET_URL"

# Set the project ID
export USER_PROJECT="USER_PROJECT"

Mengekspor link entri ke Google Spreadsheet

Untuk mengekspor link entri dalam glosarium ke Google Spreadsheet, jalankan skrip berikut:

cd export
python3 entrylinks-export.py \
  --glossary-url="$GLOSSARY_URL" \
  --spreadsheet-url="$SPREADSHEET_URL" \
  --user-project="$USER_PROJECT"

Anda dapat meninjau log eksekusi di direktori logs/ di jalur eksekusi lokal Anda. Log ini membantu Anda mengaudit proses transfer dan mengidentifikasi entri yang dilewati atau peringatan pemformatan.

Memverifikasi data link entri yang diekspor

Skrip ekspor akan mengisi Google Spreadsheet dengan kolom berikut:

Header kolom Deskripsi
entry_link_type Jenis link entri (definition, related, atau synonym).
source_entry Jalur resource lengkap dari entri sumber.
target_entry Jalur resource lengkap dari entri target.
source_path Jalur kolom atau kolom untuk link definisi.

Langkah berikutnya