Notebooks erstellen

Hinweis: BigQuery Studio-Notebooks sind ab dem 11. April 2024 allgemein verfügbar. Auf Ihrer Rechnung werden nun nutzungsbasierte Gebühren für BigQuery Studio-Notebooks angezeigt.

In diesem Dokument wird beschrieben, wie Sie Colab Enterprise-Notebooks in BigQuery erstellen. Notebooks sind BigQuery Studio-Code-Assets, die auf Dataform basieren.

Hinweise

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

BigQuery Studio aktivieren

Folgen Sie der Anleitung unter BigQuery Studio für die Asset-Verwaltung aktivieren, um Versionen von Code-Assets wie z. B. Notebooks zu speichern, freizugeben und zu verwalten.

Wichtig: Im März 2024 wurden APIs, die BigQuery Studio-Funktionen unterstützen, automatisch für alle vorhandenen BigQuery-Projekte aktiviert. Für neue BigQuery-Projekte sind diese APIs standardmäßig aktiviert. Weitere Informationen finden Sie unter BigQuery Studio APIs automatisch aktivieren.

Erforderliche Berechtigungen

Legen Sie die entsprechenden Berechtigungen zum Erstellen, Bearbeiten oder Anzeigen von Notebooks fest.

Alle Nutzer mit der Rolle „Dataform-Administrator“ (roles/dataform.admin) haben Inhaberzugriff auf alle im Projekt erstellten Notebooks.

Weitere Informationen zu BigQuery Identity and Access Management (IAM) finden Sie unter Zugriffssteuerung mit IAM.

Berechtigungen zum Erstellen von Notebooks

Zum Erstellen und Ausführen von Notebooks benötigen Sie folgende IAM-Berechtigungen:

• 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

  Hinweis: Nutzer mit der Berechtigung dataform.repositories.create können Code mit dem Dataform-Standarddienstkonto und allen diesem Dienstkonto zugewiesenen Berechtigungen ausführen. Weitere Informationen finden Sie unter Sicherheitsaspekte für Dataform-Berechtigungen.

• 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

Sie können diese Berechtigungen über die folgenden IAM-Rollen abrufen:

• BigQuery Read Session-Nutzer (roles/bigquery.readSessionUser)

• BigQuery Studio Nutzer (roles/bigquery.studioUser)

  Die Rolle „BigQuery Studio-Nutzer“ kombiniert die folgenden IAM-Rollen:

  • BigQuery-Jobnutzer(roles/bigquery.jobUser)
  • Notebook Runtime-Nutzer (roles/aiplatform.notebookRuntimeUser)

  • Code Creator (roles/dataform.codeCreator)

    Hinweis: Nutzer, denen die Rolle „Code Creator“ in einem Projekt zugewiesen ist, können die Namen von Code-Assets in diesem Projekt über die Dataform API oder die Dataform-Befehlszeile (CLI) auflisten. Nicht-Administratoren, die BigQuery Studio verwenden, sehen nur Code-Assets, die sie erstellt haben oder für sie freigegeben wurden.

Berechtigungen zum Bearbeiten von Notebooks

Zum Bearbeiten und Ausführen von Notebooks benötigen Sie die folgenden IAM-Rollen:

• BigQuery-Jobnutzer(roles/bigquery.jobUser)
• BigQuery Read Session-Nutzer (roles/bigquery.readSessionUser)
• Notebook Runtime-Nutzer (roles/aiplatform.notebookRuntimeUser)
• Code Editor (roles/dataform.codeEditor)

Berechtigungen zum Anzeigen von Notebooks

Zum Aufrufen und Ausführen von Notebooks benötigen Sie die folgenden IAM-Rollen:

• BigQuery-Jobnutzer(roles/bigquery.jobUser)
• BigQuery Read Session-Nutzer (roles/bigquery.readSessionUser)
• Notebook Runtime-Nutzer (roles/aiplatform.notebookRuntimeUser)
• Code Viewer (roles/dataform.codeViewer)

Notebooks erstellen

In den folgenden Abschnitten erfahren Sie, wie Sie ein Notebook erstellen.

Standardregion für Code-Assets festlegen

Wenn Sie zum ersten Mal ein Code-Asset erstellen, legen Sie die Standardregion für Code-Assets fest. Sie können die Region für ein Code-Asset nicht mehr ändern, nachdem es erstellt wurde.

Hinweis: Wenn Sie eine gespeicherte Abfrage erstellen und eine andere Standardregion als diejenige auswählen, die Sie für Code-Assets verwendet haben (z. B. us-west1 bei Verwendung von us-central1), wird diese neue Region standardmäßig von dieser Abfrage und allen erstellten Code-Assets verwendet. Vorhandene Code-Assets verwenden weiterhin die Region, in der sie erstellt wurden.

Notebook aus dem BigQuery-Editor erstellen

So erstellen Sie ein Notebook, das eine Standardabfrage für eine bestimmte Tabelle enthält:

1. Rufen Sie die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie in der Tableiste des Editorbereichs auf den Drop-down-Pfeil neben dem +-Zeichen und dann auf Python-Notebook erstellen:

   Das neue Notebook wird geöffnet und enthält Zellen, die Beispielabfragen für das öffentliche Dataset bigquery-public-data.ml_datasets.penguins zeigen.

Notebook aus einer Tabelle erstellen

So erstellen Sie ein Notebook, das eine Standardabfrage für eine bestimmte Tabelle enthält:

1. Rufen Sie die Seite BigQuery auf.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und suchen Sie die Tabelle, die Sie abfragen möchten.

3. Klicken Sie neben der Tabelle auf Aktionen ansehen und dann auf Abfrage in > Python-Notebook.

   Das neue Notebook wird geöffnet, das Zellen enthält, die Beispielabfragen für die ausgewählte Tabelle enthalten.

Ein Notebook erstellen, um die Ergebnismenge einer Abfrage zu untersuchen

So erstellen Sie ein Notebook, um die Ergebnismenge einer Abfrage zu untersuchen:

1. Rufen Sie die Seite BigQuery auf.

   BigQuery aufrufen

2. Führen Sie im Editorbereich eine Abfrage aus, die ein Abfrageergebnis generiert.

3. Klicken Sie im Bereich Abfrageergebnisse auf Daten auswerten und dann auf Mit Python-Notebook auswerten.

   Das neue Notebook wird geöffnet. Es enthält Zellen mit Code, um das Abfrage-SQL und die Abfrageergebnisse zurückzugeben.

Notebook aus einem vorhandenen Notebook erstellen

So öffnen Sie eine beliebige Version eines vorhandenen Notebooks als neues Notebook:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Wählen Sie ein Notebook aus.

3. Wählen Sie den Bereich Aktivität aus.

4. Klicken Sie neben einer Notebookversion auf Aktionen ansehen und dann auf Als neues Python-Notebook öffnen.

   Eine Kopie des Notebooks wird als neues Notebook geöffnet.

Notebooks hochladen

Sie können ein lokales Notebook hochladen, um es in BigQuery Studio zu verwenden. Das hochgeladene Notebook ist dann auch auf der BigQuery-Seite der Google Cloud Console sichtbar.

So aktualisieren Sie ein Notebook:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und führen Sie dann einen der folgenden Schritte aus:

   • Klicken Sie neben Notebooks auf Aktionen ansehen > In Notebooks hochladen.
   • Klicken Sie neben dem Namen des Google Cloud-Projekts auf Aktionen ansehen > In Projekt hochladen > Python-Notebook.

3. Klicken Sie im Dialogfeld Notebook hochladen im Feld Notebook auf Durchsuchen und wählen Sie das Notebook aus, das Sie hochladen möchten.

4. Optional: Bearbeiten Sie im Feld Notebookname den Namen des Notebooks.

5. Wählen Sie im Feld Region die Region aus, in die Sie Ihr Notebook hochladen möchten.

6. Klicken Sie auf Hochladen.

Ihr Notebook wird im Explorer-Bereich angezeigt.

Mit einer Laufzeit verbinden

In den folgenden Abschnitten erfahren Sie, wie Sie ein Notebook mit einer Vertex AI-Laufzeit verbinden. Eine Laufzeit ist eine Computing-Ressource, die den Code in Ihrem Notebook ausführt.

Weitere Informationen zu Laufzeiten finden Sie unter Laufzeiten und Laufzeitvorlagen.

Verbindung zur Standardlaufzeit herstellen

Die Standardlaufzeit ist eine voreingestellte Laufzeit, die nur minimale Einrichtung erfordert.

So stellen Sie eine Verbindung zur Standardlaufzeit her:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Klicken Sie auf den Namen eines Notebooks, um es zu öffnen.

3. Klicken Sie im Notebook auf Verbinden oder führen Sie eine beliebige Zelle im Notebook aus.

   Es kann einige Minuten dauern, bis eine Verbindung zur Standardlaufzeit hergestellt wird, wenn Sie noch keine aktive Laufzeit haben.

Verbindung zu einer nicht standardmäßigen Laufzeit herstellen

Wenn Sie eine andere Laufzeit als die Standardlaufzeit verwenden möchten, müssen Sie zuerst diese zusätzliche Laufzeit in Vertex AI erstellen.

So stellen Sie eine Verbindung zur Nicht-Standardlaufzeit her:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Klicken Sie auf den Namen eines Notebooks, um es zu öffnen.

3. Klicken Sie im Notebook auf das Drop-down-Menü neben Verbinden und dann auf Mit einer Laufzeit verbinden.

4. Klicken Sie auf Mit einer vorhandenen Laufzeit verbinden.

5. Wählen Sie unter Laufzeiten die zu verwendende Laufzeit aus.

6. Klicken Sie auf Verbinden.

Mit neuer Laufzeit verbinden

So stellen Sie eine Verbindung zu einer neuen Laufzeit her:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Klicken Sie auf den Namen eines Notebooks, um es zu öffnen.

3. Klicken Sie im Notebook auf das Drop-down-Menü neben Verbinden und dann auf Mit einer Laufzeit verbinden.

4. Klicken Sie auf Neue Laufzeit erstellen.

5. Wählen Sie unter Laufzeitvorlage die zu verwendende Vertex AI-Laufzeitvorlage aus.

6. Geben Sie unter Laufzeitname einen Namen für die Laufzeit ein.

7. Klicken Sie auf Verbinden.

Zugriff auf Notebooks gewähren

Wenn Sie anderen Nutzern Zugriff auf ein Notebook gewähren möchten, fügen Sie diese Nutzer einer entsprechenden IAM-Rolle hinzu.

Wichtig: Nutzer, die Zugriff auf das Notebook haben, können die gesamte, von Code im Notebook generierte Ausgabe sehen, auch wenn diese Ausgabe Daten aus Tabellen enthält, auf die keinen Zugriff haben. Deaktivieren Sie das Speichern der Notebookausgabe, um zu verhindern, dass die gespeicherte Ausgabe freigegeben wird.

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Suchen Sie das Notebook, auf das Sie Zugriff gewähren möchten.

3. Klicken Sie neben dem Notebook auf Aktionen ansehen und dann auf Freigeben > Berechtigungen verwalten.

4. Klicken Sie im Bereich Berechtigungen verwalten auf Nutzer/Gruppe hinzufügen.

5. Geben Sie im Feld Neue Hauptkonten ein Hauptkonto ein.

6. Wählen Sie in der Liste Rolle eine der folgenden Rollen aus:

   • Code-Inhaber: Kann alle Aktionen für das Notebook ausführen, einschließlich Löschen oder Freigeben.
   • Code-Editor: Kann das Notebook bearbeiten.
   • Code-Betrachter: Kann das Notebook aufrufen.
   Hinweis: Das Hauptkonto muss zum Ausführen des Notebooks auch über die Rollen Notebook-Laufzeitnutzer (roles/aiplatform.notebookRuntimeUser) und BigQuery-Nutzer (roles/bigquery.user) verfügen.

7. Optional: Klicken Sie auf Erweiterte Freigabe, um eine vollständige Liste der Rollen und erweiterten Freigabeeinstellungen aufzurufen.

8. Klicken Sie auf Speichern.

9. Klicken Sie auf Schließen, um zur Seite mit den Notebook-Informationen zurückzukehren.

Notebooks teilen

Wenn Sie ein Notebook für andere Nutzer freigeben möchten, können Sie einen Link zum Notebook generieren und freigeben. Damit andere Nutzer das von Ihnen freigegebene Notebook sehen können, müssen Sie zuerst den Zugriff auf das Notebook gewähren.

Zum Ausführen eines Notebooks benötigen Nutzer Zugriff auf die Daten, auf die das Notebook zugreift. Weitere Informationen finden Sie unter Zugriff auf ein Dataset gewähren.

Wichtig: Nutzer, die Zugriff auf das Notebook haben, können die gesamte, von Code im Notebook generierte Ausgabe sehen, auch wenn diese Ausgabe Daten aus Tabellen enthält, auf die keinen Zugriff haben. Deaktivieren Sie das Speichern der Notebookausgabe, um zu verhindern, dass die gespeicherte Ausgabe freigegeben wird.

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Suchen Sie den Ordner, den Sie umbenennen möchten.

3. Klicken Sie neben dem Notebook auf Aktionen ansehen und dann auf Freigeben > Link kopieren.

4. Geben Sie den Link für andere Nutzer frei.

Speichern der Notebook-Ausgabe deaktivieren

Um die Freigabe der gespeicherten Notebookausgabe für andere Nutzer mit Zugriff auf die Notebookdatei zu verhindern, deaktivieren Sie das Speichern der Notebookausgabe.

Wenn Sie das Speichern der Ausgabe für ein ausgewähltes Notebook deaktivieren, löscht BigQuery alle in der Notebookdatei gespeicherten Ausgaben und speichert die Ausgabe der nachfolgenden Ausführungen nicht.

Nutzer mit Zugriff auf das Notebook können die Ausgabe jedoch so aufrufen:

• Führen Sie das Notebook aus, um die aktuelle Ausgabe aufzurufen. Diese Ausgabe wird nicht gespeichert.
• Sie können eine Archivversion des Notebooks und seine Ausgabe im Überarbeitungsverlauf ansehen.

So deaktivieren Sie das Speichern der Ausgabe für ein ausgewähltes Notebook:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und wählen Sie dann das Notebook aus, für das Sie das Speichern der Ausgabe deaktivieren möchten.

3. Klicken Sie auf Header-Sichtbarkeit umschalten > Bearbeiten > Notebook-Einstellungen.

4. Wählen Sie im Fenster Notebookeinstellungen die Option Codezellenausgabe beim Speichern dieses Notebooks weglassen aus.

5. Klicken Sie auf Speichern.

6. Klicken Sie auf Neu laden.

Konflikte lösen

Wenn Sie und ein anderer Nutzer in einem Notebook widersprüchliche Änderungen vornehmen, löst der Dienst den Fehler Automatic saving failed. This file was updated remotely or in another tab. aus und stellt den Link Show diff bereit. So beheben Sie den Konflikt:

1. Klicken Sie auf den Show diff-Link. Das Dialogfeld Remote-Änderungen prüfen wird geöffnet.
2. Optional: Klicken Sie das Kästchen Rohquelle an, um den Notebook-Quellcode zu vergleichen.
3. Optional: Klicken Sie das Kästchen Inline-Unterschiede an, um die Versionen inline und nicht in separaten Bereichen zu vergleichen.
4. Prüfen Sie die Änderungen und entscheiden Sie, welche beibehalten werden sollen, und überarbeiten Sie Ihre Eingabe bei Bedarf.
5. Klicken Sie auf Änderungen speichern.

Notebooks umbenennen

So benennen Sie ein Notebook um:

1. Öffnen Sie in der Google Cloud Console die Seite BigQuery.

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Explorer und gegebenenfalls den Ordner Explorer. Suchen Sie den Ordner, den Sie umbenennen möchten.

3. Klicken Sie neben dem Notebook auf Aktionen ansehen und dann auf Umbenennen.

4. Geben Sie einen Namen für das Notebook ein und klicken Sie auf Umbenennen.

Fehlerbehebung

Weitere Informationen finden Sie unter Fehlerbehebung bei Colab Enterprise.

Nächste Schritte

• Notebooks verwalten