Membuat notebook

Dokumen ini menjelaskan cara membuat notebook Colab Enterprise di BigQuery. Notebook adalah aset kode BigQuery Studio yang didukung oleh Dataform.

Sebelum memulai

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the BigQuery API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the BigQuery API.

   Enable the API

Mengaktifkan BigQuery Studio

Ikuti petunjuk di artikel Mengaktifkan BigQuery Studio untuk pengelolaan aset untuk menyimpan, membagikan, dan mengelola versi aset kode seperti notebook.

Izin yang diperlukan

Tetapkan izin yang sesuai untuk membuat, mengedit, atau melihat notebook.

Semua pengguna dengan peran Admin Dataform (roles/dataform.admin) memiliki akses pemilik ke semua notebook yang dibuat dalam project.

Untuk mengetahui informasi selengkapnya tentang Identity and Access Management (IAM) BigQuery, lihat Kontrol akses dengan IAM.

Izin untuk membuat notebook

Untuk membuat dan menjalankan notebook, Anda memerlukan izin IAM berikut:

• resourcemanager.projects.get
• resourcemanager.projects.list
• bigquery.config.get
• bigquery.jobs.create
• bigquery.readsessions.create
• bigquery.readsessions.getData
• bigquery.readsessions.update
• resourcemanager.projects.get
• resourcemanager.projects.list
• dataform.locations.get
• dataform.locations.list

• dataform.repositories.create

  Catatan: Pengguna yang memiliki izin dataform.repositories.create dapat mengeksekusi kode menggunakan akun layanan Dataform default dan semua izin yang diberikan ke akun layanan tersebut. Untuk mengetahui informasi selengkapnya, lihat Pertimbangan keamanan untuk izin Dataform.

• dataform.repositories.list

• dataform.collections.create

• dataform.collections.list

• aiplatform.notebookRuntimeTemplates.apply

• aiplatform.notebookRuntimeTemplates.get

• aiplatform.notebookRuntimeTemplates.list

• aiplatform.notebookRuntimeTemplates.getIamPolicy

• aiplatform.notebookRuntimes.assign

• aiplatform.notebookRuntimes.get

• aiplatform.notebookRuntimes.list

• aiplatform.operations.list

Anda bisa mendapatkan izin ini dari peran IAM berikut:

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

• Pengguna BigQuery Studio (roles/bigquery.studioUser)

  Peran Pengguna BigQuery Studio menggabungkan peran IAM berikut:

  • BigQuery Job User (roles/bigquery.jobUser)
  • Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)

  • Code Creator (roles/dataform.codeCreator)

    Catatan: Pengguna yang diberi peran Code Creator dalam project dapat mencantumkan nama aset kode dalam project tersebut menggunakan Dataform API atau antarmuka command line (CLI) Dataform. Pengguna non-administrator yang menggunakan BigQuery Studio hanya dapat melihat aset kode yang mereka buat atau yang dibagikan kepada mereka.

Izin untuk mengedit notebook

Untuk mengedit dan menjalankan notebook, Anda memerlukan peran IAM berikut:

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)
• Editor Kode (roles/dataform.codeEditor)

Izin untuk melihat notebook

Untuk melihat dan menjalankan notebook, Anda memerlukan peran IAM berikut:

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)
• Pelihat Kode (roles/dataform.codeViewer)

Membuat notebook

Gunakan bagian berikut untuk mempelajari cara membuat notebook.

Menetapkan region default untuk aset kode

Jika ini adalah kali pertama Anda membuat aset kode, tetapkan region default untuk aset kode. Anda tidak dapat mengubah region untuk aset kode setelah dibuat.

Catatan: Jika Anda membuat kueri tersimpan dan memilih region default yang berbeda dengan yang telah digunakan untuk aset kode, misalnya memilih us-west1 saat Anda menggunakan us-central1, maka kueri tersebut dan semua aset kode yang Anda buat setelahnya akan menggunakan region baru tersebut secara default. Aset kode yang ada akan terus menggunakan region yang ditetapkan saat aset tersebut dibuat.

Membuat notebook dari editor BigQuery

Untuk membuat notebook yang berisi kueri default untuk tabel tertentu, ikuti langkah-langkah berikut:

1. Buka halaman BigQuery.

   Buka BigQuery

2. Di panel tab panel editor, klik panah drop-down di samping tanda +, lalu klik Create Python notebook.

   Notebook baru ini akan terbuka, yang berisi sel yang menunjukkan contoh kueri terhadap set data publik bigquery-public-data.ml_datasets.penguins.

Membuat notebook dari tabel

Untuk membuat notebook yang berisi kueri default untuk tabel tertentu, ikuti langkah-langkah berikut:

1. Buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda dan temukan tabel yang ingin Anda buat kuerinya.

3. Klik View actions di samping tabel, klik Query in > Python notebook.

   Notebook baru akan terbuka, yang berisi sel yang menampilkan contoh kueri pada tabel yang dipilih.

Membuat notebook untuk menjelajahi set hasil kueri

Untuk membuat notebook guna menjelajahi set hasil kueri, ikuti langkah-langkah berikut:

1. Buka halaman BigQuery.

   Buka BigQuery

2. Di panel editor, jalankan kueri yang menghasilkan hasil kueri.

3. Di panel Query results, klik Explore Data, lalu klik Explore with Python notebook.

   Notebook baru akan terbuka, yang berisi sel dengan kode untuk menampilkan SQL kueri dan hasil kueri.

Membuat notebook dari notebook lama

Untuk membuka versi notebook lama sebagai notebook baru, 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. Pilih notebook.

3. Pilih panel Activity.

4. Klik View actions di samping versi notebook, lalu klik Open as new Python notebook.

   Salinan notebook akan dibuka sebagai notebook baru.

Mengupload notebook

Anda dapat mengupload notebook lokal untuk menggunakannya di BigQuery Studio. Notebook yang diupload kemudian terlihat di halaman BigQuery pada konsol Google Cloud.

Untuk mengupload notebook, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud, buka halaman BigQuery.

   Buka BigQuery

2. Di panel Explorer, luaskan project Anda, lalu lakukan salah satu tindakan berikut:

   • Di samping Notebook, klik View actions > Upload to Notebooks.
   • Di samping nama project Google Cloud, klik View actions > Upload to project > Python notebook.

3. Di dialog Upload Notebook, di kolom Notebook, klik Browse, lalu pilih notebook yang ingin Anda upload.

4. Opsional: Di kolom Nama notebook, edit nama notebook.

5. Di kolom Region, pilih region tempat Anda ingin mengupload notebook.

6. Klik Upload.

Notebook Anda akan muncul di panel Penjelajah.

Menghubungkan ke runtime

Gunakan bagian berikut untuk mempelajari cara menghubungkan notebook ke runtime Vertex AI. Runtime adalah resource komputasi yang menjalankan kode di notebook Anda.

Untuk mengetahui informasi selengkapnya tentang runtime, lihat Runtime dan template runtime.

Menghubungkan ke runtime default

Runtime default adalah runtime preset yang memerlukan penyiapan minimal.

Untuk terhubung ke runtime default, 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 untuk membukanya.

3. Di notebook, klik Connect, atau jalankan sel apa pun di notebook.

   Mungkin perlu waktu beberapa menit untuk terhubung ke runtime default jika Anda belum memiliki runtime yang aktif.

Menghubungkan ke runtime non-default

Jika ingin menggunakan runtime selain runtime default, Anda harus terlebih dahulu membuat runtime tambahan tersebut di Vertex AI.

Untuk terhubung ke runtime non-default, 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 untuk membukanya.

3. Di notebook, klik drop-down di samping Connect, lalu klik Connect to a runtime.

4. Klik Connect to an existing runtime.

5. Di bagian Runtime, pilih runtime yang akan digunakan.

6. Klik Connect.

Menghubungkan ke runtime baru

Untuk terhubung ke runtime baru, 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 untuk membukanya.

3. Di notebook, klik drop-down di samping Connect, lalu klik Connect to a runtime.

4. Klik Create new runtime.

5. Di bagian Runtime Template, pilih template runtime Vertex AI yang akan digunakan.

6. Di bagian Runtime name, ketik nama runtime.

7. Klik Connect.

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.

Menonaktifkan penyimpanan output notebook

Anda dapat mencegah pembagian output notebook tersimpan dengan pengguna lain yang memiliki akses ke file notebook dengan menonaktifkan penyimpanan output notebook.

Jika Anda menonaktifkan penyimpanan output untuk notebook yang dipilih, BigQuery akan menghapus semua output yang disimpan dalam file notebook dan tidak menyimpan output dari operasi berikutnya.

Namun, pengguna yang memiliki akses ke notebook masih dapat melihat outputnya dengan cara berikut:

• Jalankan notebook untuk melihat output saat ini. Output ini tidak disimpan.
• Lihat versi arsip notebook dan output-nya dalam histori revisi.

Untuk menonaktifkan penyimpanan output untuk notebook yang dipilih, ikuti langkah-langkah berikut:

1. Di konsol Google Cloud, buka halaman BigQuery.

   Buka BigQuery

2. Di panel Penjelajah, luaskan project dan folder Notebook, lalu pilih notebook yang outputnya ingin Anda nonaktifkan.

3. Klik Alihkan visibilitas header > Edit > Setelan notebook.

4. Di jendela Notebook settings, pilih Omit code cell output when saving this notebook.

5. Klik Simpan.

6. Klik Muat ulang.

Selesaikan konflik

Jika Anda dan pengguna lain membuat perubahan yang bertentangan dalam notebook, layanan akan menampilkan error Automatic saving failed. This file was updated remotely or in another tab. dan memberikan link Show diff. Untuk menyelesaikan konflik, ikuti langkah-langkah berikut:

1. Klik link Show diff. Dialog Tinjau perubahan jarak jauh akan terbuka.
2. Opsional: Untuk membandingkan kode sumber notebook, centang kotak Sumber mentah.
3. Opsional: Untuk membandingkan versi secara inline, bukan di panel terpisah, centang kotak Inline diff.
4. Tinjau perubahan dan tentukan mana yang akan disimpan, dengan merevisi input Anda jika diperlukan.
5. Klik Simpan perubahan.

Mengganti nama notebook

Untuk mengganti nama 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. Temukan notebook yang ingin diganti namanya.

3. Klik View actions di samping notebook, lalu klik Rename.

4. Ketik nama untuk notebook, lalu klik Rename.

Pemecahan masalah

Untuk mengetahui informasi selengkapnya, lihat Memecahkan Masalah Colab Enterprise.

Langkah selanjutnya

• Pelajari cara mengelola notebook.
• Pelajari cara mengoordinasikan notebook.