Mengelola notebook

Dokumen ini menjelaskan cara mengelola notebook Colab Enterprise di BigQuery, termasuk cara melihat, membandingkan, memulihkan, dan menghapus notebook.

Dokumen ini juga menjelaskan cara melihat dan mengelola metadata notebook di Dataplex.

Notebook adalah aset kode BigQuery Studio yang didukung oleh Dataform.

Sebelum memulai

1. Buat notebook.
2. Untuk mengelola metadata notebook di Dataplex, pastikan Dataplex API diaktifkan di project Google Cloud Anda.

Izin yang diperlukan

Untuk membagikan notebook, Anda memerlukan peran Identity and Access Management (IAM) berikut:

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• Pemilik Kode (roles/dataform.codeOwner) di tingkat resource.

Untuk menyimpan dan menghapus notebook, Anda memerlukan peran IAM berikut:

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• Pemilik Kode (roles/dataform.codeOwner) atau Editor Kode (roles/dataform.codeEditor)

Untuk menggunakan revisi notebook, Anda memerlukan peran IAM berikut:

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)

• Salah satu dari peran berikut:

  • Pemilik Kode (roles/dataform.codeOwner)
  • Editor Kode (roles/dataform.codeEditor)
  • Pelihat Kode (roles/dataform.codeViewer)

Untuk mengetahui informasi selengkapnya tentang IAM BigQuery, lihat Kontrol akses dengan IAM.

Untuk mengelola metadata notebook di Dataplex, pastikan Anda memiliki peran Dataplex yang diperlukan.

Memberikan akses ke notebook

Untuk memberi pengguna lain akses ke notebook, tambahkan pengguna tersebut ke peran IAM yang sesuai.

Penting: Pengguna yang memiliki akses ke notebook dapat melihat semua output yang dihasilkan oleh kode di notebook, meskipun output ini berisi data dari tabel yang tidak mereka miliki aksesnya. Untuk mencegah output tersimpan dibagikan, nonaktifkan penyimpanan output notebook.

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda dan folder Notebooks, dan jika perlu, folder Shared notebooks. Temukan notebook yang ingin Anda berikan aksesnya.

3. Klik Lihat tindakan di samping notebook, lalu klik Bagikan > Kelola Izin.

4. Di panel Manage permissions, klik Add user/group.

5. Di kolom New principals, masukkan akun utama.

6. Di daftar Role, pilih salah satu peran berikut:

   • Code Owner: Dapat melakukan tindakan apa pun pada notebook, termasuk menghapus atau membagikannya.
   • Code Editor: Dapat mengedit notebook.
   • Code Viewer: Dapat melihat notebook.
   Catatan: Akun utama juga harus memiliki peran Notebook Runtime User (roles/aiplatform.notebookRuntimeUser ) dan BigQuery User (roles/bigquery.user ) yang diperlukan untuk menjalankan notebook.

7. Opsional: Untuk melihat daftar lengkap peran dan setelan berbagi lanjutan, klik Berbagi lanjutan.

8. Klik Simpan.

9. Untuk kembali ke halaman informasi notebook, klik Close.

Membagikan notebook

Untuk membagikan notebook kepada pengguna lain, Anda dapat membuat dan membagikan link ke notebook. Agar pengguna lain dapat melihat notebook yang Anda bagikan, Anda harus memberikan akses ke notebook tersebut terlebih dahulu.

Untuk menjalankan notebook, pengguna harus memiliki akses ke data yang diakses notebook. Untuk mengetahui informasi selengkapnya, lihat Memberikan akses ke set data.

Penting: Pengguna yang memiliki akses ke notebook dapat melihat semua output yang dihasilkan oleh kode di notebook, meskipun output ini berisi data dari tabel yang tidak mereka miliki aksesnya. Untuk mencegah output tersimpan dibagikan, nonaktifkan penyimpanan output notebook.

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda dan folder Notebooks, dan jika perlu, luaskan folder Shared notebooks. Cari notebook yang ingin Anda bagikan.

3. Klik Lihat tindakan di samping notebook, lalu klik Bagikan > Salin link.

4. Bagikan link kepada pengguna lain.

Melihat semua notebook

Untuk melihat daftar semua notebook dalam project Anda, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, klik Lihat tindakan di samping Notebook, lalu lakukan salah satu tindakan berikut:

• Untuk membuka daftar di tab saat ini, klik Tampilkan semua.
• Untuk membuka daftar di tab baru, klik Tampilkan semua di > Tab baru.
• Untuk membuka daftar di tab terpisah, klik Tampilkan semua di > Tab terpisah.

Melihat metadata notebook

Untuk melihat metadata notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project Anda dan folder Notebook, dan jika perlu, folder Notebook bersama. Klik nama notebook yang ingin Anda lihat metadatanya.

3. Lihat panel Ringkasan untuk mengetahui informasi tentang notebook, seperti region yang digunakan untuk data dan tanggal notebook terakhir diubah.

Menggunakan versi notebook

Gunakan bagian berikut untuk mempelajari cara melihat, membandingkan, dan memulihkan versi notebook.

Melihat versi notebook

Untuk melihat versi notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda dan folder Notebooks, dan jika perlu, folder Shared notebooks. Klik nama notebook yang ingin Anda lihat aktivitasnya.

3. Klik tab Aktivitas untuk melihat daftar versi notebook dalam urutan yang menurun berdasarkan tanggal.

Membandingkan versi notebook

Untuk membandingkan versi notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project Anda dan folder Notebook, dan jika perlu, folder Notebook bersama. Klik nama notebook yang ingin Anda bandingkan informasi versinya.

3. Di tab Aktivitas, klik Lihat tindakan di samping versi notebook, lalu klik Bandingkan. Panel perbandingan akan terbuka, yang membandingkan versi notebook yang Anda pilih dengan versi notebook saat ini.

4. Opsional: Untuk membandingkan versi secara inline, bukan di panel terpisah, klik Bandingkan, lalu klik Inline.

5. Opsional: Untuk membandingkan kode sumber versi, klik Bandingkan, lalu klik Tampilkan sumber mentah.

6. Opsional: Untuk menyembunyikan output perintah di notebook, klik Compare, lalu hapus centang dari Show output.

Memulihkan versi notebook

Gunakan salah satu opsi berikut untuk memulihkan versi notebook. Memulihkan dari panel perbandingan memungkinkan Anda membandingkan versi notebook saat ini dan sebelumnya sebelum memilih untuk memulihkan versi sebelumnya. Memulihkan notebook akan membuat versi baru dari notebook, bukan menimpa versi saat ini. Tidak ada histori versi yang hilang.

Panel aktivitas

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project Anda dan folder Notebook, dan jika perlu, luaskan folder Notebook bersama. Klik nama notebook yang ingin Anda pulihkan ke versi sebelumnya.

3. Pilih panel Aktivitas.

4. Klik Lihat tindakan di samping versi notebook yang ingin Anda pulihkan, lalu klik Pulihkan.

5. Klik Konfirmasi.

Panel perbandingan

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project Anda dan folder Notebook, dan jika perlu, luaskan folder Notebook bersama. Klik nama notebook yang ingin Anda pulihkan ke versi sebelumnya.

3. Pilih panel Aktivitas.

4. Klik Lihat tindakan di samping versi notebook, lalu klik Bandingkan. Panel perbandingan akan terbuka, yang membandingkan versi notebook yang Anda pilih dengan versi notebook terbaru.

5. Jika Anda ingin memulihkan versi notebook sebelumnya setelah perbandingan, klik Pulihkan.

6. Klik Konfirmasi.

Mendownload notebook

Untuk mendownload notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project Anda dan folder Notebook, dan jika perlu, folder Notebook bersama. Klik nama notebook yang ingin Anda download.

3. Klik Download.

Menghapus notebook

Untuk menghapus notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud , buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda dan folder Notebooks, dan jika perlu, luaskan folder Shared notebooks. Temukan notebook yang ingin Anda hapus.

3. Klik Lihat tindakan di samping notebook, lalu klik Hapus.

4. Untuk mengonfirmasi penghapusan, ketik delete pada dialog.

5. Klik Hapus.

Mengelola metadata di Dataplex

Dataplex memungkinkan Anda menyimpan dan mengelola metadata untuk notebook. Notebook tersedia di Dataplex secara default, tanpa konfigurasi tambahan.

Anda dapat menggunakan Dataplex untuk mengelola notebook di semua lokasi BigQuery. Pengelolaan notebook di Dataplex tunduk pada kuota dan batas Dataplex dan harga Dataplex.

Dataplex otomatis mengambil metadata berikut dari notebook:

• Nama aset data
• Induk aset data
• Lokasi aset data
• Jenis aset data
• Project Google Cloud yang sesuai

Dataplex mencatat notebook sebagai entri dengan nilai entri berikut:

Grup entri sistem

Grup entri sistem untuk notebook adalah @dataform. Untuk melihat detail entri notebook di Dataplex, Anda perlu melihat grup entri sistem dataform. Untuk mengetahui petunjuk tentang cara melihat daftar semua entri dalam grup entri, lihat Melihat detail grup entri dalam dokumentasi Dataplex.

Jenis entri sistem

Jenis entri sistem untuk notebook adalah dataform-code-asset. Untuk melihat detail notebook, Anda perlu melihat jenis entri sistem dataform-code-asset, memfilter hasil dengan filter berbasis aspek, dan menetapkan kolom type di dalam aspek dataform-code-asset ke NOTEBOOK. Kemudian, pilih entri dari notebook yang dipilih. Untuk petunjuk tentang cara melihat detail jenis entri yang dipilih, lihat Melihat detail jenis entri dalam dokumentasi Dataplex. Untuk petunjuk tentang cara melihat detail entri yang dipilih, lihat Melihat detail entri dalam dokumentasi Dataplex.

Jenis aspek sistem

Jenis aspek sistem untuk notebook adalah dataform-code-asset. Untuk memberikan konteks tambahan ke notebook di Dataplex dengan menganotasi entri notebook dengan aspek, lihat jenis aspek dataform-code-asset, filter hasil dengan filter berbasis aspek, dan tetapkan kolom type di dalam aspek dataform-code-asset ke NOTEBOOK. Untuk petunjuk tentang cara menganotasi entri dengan aspek, lihat Mengelola aspek dan memperkaya metadata dalam dokumentasi Dataplex.

Jenis

Jenis untuk kanvas data adalah NOTEBOOK. Jenis ini memungkinkan Anda memfilter notebook dalam jenis entri sistem dataform-code-asset dan jenis aspek dataform-code-asset menggunakan kueri aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK dalam filter berbasis aspek.

Untuk petunjuk tentang cara menelusuri aset di Dataplex, lihat Menelusuri aset data di Dataplex dalam dokumentasi Dataplex.

Pemecahan masalah

Untuk mengetahui informasi selengkapnya, lihat Memecahkan Masalah Colab Enterprise.

Langkah selanjutnya

• Pelajari notebook Colab Enterprise di BigQuery lebih lanjut.
• Pelajari cara membuat notebook.
• Pelajari cara mengoordinasikan notebook.