Notebooks verwalten

In diesem Dokument wird beschrieben, wie Sie Colab Enterprise-Notebooks in BigQuery verwalten, einschließlich der Anzeige, des Vergleichs, der Wiederherstellung und des Löschens von Notebooks.

In diesem Dokument wird auch beschrieben, wie Sie Notebook-Metadaten in Dataplex aufrufen und verwalten.

Notebooks sind BigQuery Studio-Code-Assets, die auf Dataform basieren.

Hinweise

1. Erstellen Sie ein Notebook.
2. Wenn Sie Notebook-Metadaten in Dataplex verwalten möchten, muss die Dataplex API in Ihrem Google Cloud -Projekt aktiviert sein.

Erforderliche Berechtigungen

Zum Freigeben von Notebooks benötigen Sie die folgenden IAM-Rollen (Identity and Access Management):

• BigQuery-Jobnutzer(roles/bigquery.jobUser)
• BigQuery Read Session-Nutzer (roles/bigquery.readSessionUser)
• Code-Inhaber (roles/dataform.codeOwner) auf Ressourcenebene.

Zum Speichern und Löschen von Notebooks benötigen Sie die folgenden IAM-Rollen:

• BigQuery-Jobnutzer(roles/bigquery.jobUser)
• BigQuery Read Session-Nutzer (roles/bigquery.readSessionUser)
• Code-Inhaber (roles/dataform.codeOwner) oder Code-Editor (roles/dataform.codeEditor)

Für die Arbeit mit Notebooküberarbeitungen benötigen Sie die folgenden IAM-Rollen:

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

• Eine der folgenden Rollen:

  • Code-Inhaber (roles/dataform.codeOwner)
  • Code-Editor (roles/dataform.codeEditor)
  • Code-Betrachter (roles/dataform.codeViewer)

Weitere Informationen zu BigQuery IAM finden Sie unter Zugriffssteuerung mit IAM.

Wenn Sie Notebook-Metadaten in Dataplex verwalten möchten, benötigen Sie die erforderlichen Dataplex-Rollen.

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 Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. 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 Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. 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.

Alle Notebooks ansehen

So rufen Sie eine Liste aller Notebooks in Ihrem Projekt auf:

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

   BigQuery aufrufen

2. Klicken Sie im Bereich Explorer neben Notebooks auf Aktionen anzeigen und führen Sie einen der folgenden Schritte aus:

• Wenn Sie die Liste im aktuellen Tab öffnen möchten, klicken Sie auf Alle anzeigen.
• Wenn Sie die Liste in einem neuen Tab öffnen möchten, klicken Sie auf Alle anzeigen in > Neuer Tab.
• Wenn Sie die Liste in einem geteilten Tab öffnen möchten, klicken Sie auf Alle anzeigen in > Tab aufteilen.

Notebook-Metadaten ansehen

So rufen Sie die Notebook-Metadaten auf:

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, für das Sie Metadaten aufrufen möchten.

3. Im Bereich Zusammenfassung finden Sie Informationen zum Notebook, z. B. die Region, die es für Daten verwendet, und das Datum, an dem es zuletzt geändert wurde.

Mit Notebook-Versionen arbeiten

In den folgenden Abschnitten erfahren Sie, wie Sie Versionen eines Notebooks aufrufen, vergleichen und wiederherstellen.

Notebookversionen ansehen

So rufen Sie Notebook-Versionen auf:

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, für das Sie Aktivitäten aufrufen möchten.

3. Klicken Sie auf den Tab Aktivität, um eine Liste der Notebookversionen in absteigender Reihenfolge nach Datum aufzurufen.

Notebook-Versionen vergleichen

Um Notebook-Versionen zu vergleichen, führen Sie folgende Schritte aus.:

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, für das Sie die Versionsinformationen vergleichen möchten.

3. Klicken Sie auf dem Tab Aktivität neben einer Notebook-Version auf Aktionen ansehen und dann auf Vergleichen. Der Vergleichsbereich wird geöffnet und die ausgewählte Notebookversion wird mit der aktuellen Notebookversion verglichen.

4. Optional: Wenn Sie die Versionen inline und nicht in separaten Bereichen vergleichen möchten, klicken Sie auf Vergleichen und dann auf Inline.

5. Optional: Wenn Sie den Quellcode der Versionen vergleichen möchten, klicken Sie auf Vergleichen und dann auf Rohquelle anzeigen.

6. Optional: Wenn Sie die Befehlsausgabe im Notebook ausblenden möchten, klicken Sie auf Vergleichen und entfernen Sie dann das Häkchen bei Ausgabe anzeigen.

Notebook-Version wiederherstellen

Verwenden Sie eine der folgenden Optionen, um eine Notebook-Version wiederherzustellen. Wenn Sie über den Vergleichsbereich wiederherstellen, können Sie die aktuelle und die vorherige Version des Notebooks vergleichen, bevor Sie die vorherige Version wiederherstellen. Beim Wiederherstellen eines Notebooks wird eine neue Version des Notebooks erstellt, anstatt die aktuelle Version zu überschreiben. Der Versionsverlauf geht nicht verloren.

Aktivitätsbereich

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, von dem Sie eine vorherige Version wiederherstellen möchten.

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

4. Klicken Sie neben der Version des Notebooks, die Sie wiederherstellen möchten, auf Aktionen ansehen und dann auf Wiederherstellen.

5. Klicken Sie auf Bestätigen.

Vergleichsbereich

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, von dem Sie eine vorherige Version wiederherstellen möchten.

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

4. Klicken Sie neben einer Notebook-Version auf Aktionen ansehen und dann auf Vergleichen. Der Vergleichsbereich wird geöffnet und die ausgewählte Notebookversion wird mit der neuesten Notebookversion verglichen.

5. Wenn Sie nach dem Vergleich die vorherige Notebookversion wiederherstellen möchten, klicken Sie auf Wiederherstellen.

6. Klicken Sie auf Bestätigen.

Notebook herunterladen

So laden Sie ein Notebook herunter:

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Klicken Sie auf den Namen des Notebooks, das Sie herunterladen möchten.

3. Klicken Sie auf Herunterladen.

Notebooks löschen

Zum Löschen eines Notebooks führen Sie diese Schritte aus:

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

   BigQuery aufrufen

2. Maximieren Sie im Bereich Explorer Ihr Projekt und den Ordner Notebooks und gegebenenfalls den Ordner Freigegebene Notebooks. Suchen Sie den Ordner, den Sie löschen möchten.

3. Klicken Sie neben dem Notebook auf Aktionen ansehen und dann auf Löschen.

4. Geben Sie delete in das Dialogfeld ein, um den Löschvorgang zu bestätigen.

5. Klicken Sie auf Löschen.

Metadaten in Dataplex verwalten

Mit Dataplex können Sie Metadaten für Notebooks speichern und verwalten. Notebooks sind in Dataplex standardmäßig ohne zusätzliche Konfiguration verfügbar.

Mit Dataplex können Sie Notebooks an allen BigQuery-Standorten verwalten. Die Verwaltung von Notebooks in Dataplex unterliegt den Kontingenten und Limits für Dataplex und den Dataplex-Preisen.

Dataplex ruft automatisch die folgenden Metadaten aus Notebooks ab:

• Name des Daten-Assets
• Übergeordnetes Daten-Asset
• Speicherort des Daten-Assets
• Daten-Asset-Typ
• Entsprechendes Google Cloud -Projekt

In Dataplex werden Notebooks als Einträge mit den folgenden Eintragswerten protokolliert:

Systemeintragsgruppe

Die Systemeintragsgruppe für Notebooks lautet @dataform. Wenn Sie Details zu Notizeneinträgen in Dataplex aufrufen möchten, müssen Sie die Systemeintragsgruppe dataform aufrufen. Eine Anleitung zum Aufrufen einer Liste aller Einträge in einer Eintragsgruppe finden Sie in der Dataplex-Dokumentation unter Details einer Eintragsgruppe aufrufen.

Systemeintragstyp

Der Systemeintragstyp für Notebooks ist dataform-code-asset. Wenn Sie Details zu Notizen aufrufen möchten, müssen Sie den Systemeintragstyp dataform-code-asset aufrufen, die Ergebnisse mit einem aspektbasierten Filter filtern und das Feld type im Aspekt dataform-code-asset auf NOTEBOOK setzen. Wählen Sie dann einen Eintrag aus dem ausgewählten Notizbuch aus. Eine Anleitung zum Aufrufen von Details zu einem ausgewählten Eintragstyp finden Sie in der Dataplex-Dokumentation unter Details zu einem Eintragstyp aufrufen. Eine Anleitung zum Aufrufen der Details eines ausgewählten Eintrags finden Sie in der Dataplex-Dokumentation unter Details eines Eintrags aufrufen.

Systemaspekttyp

Der Systemaspekttyp für Notebooks ist dataform-code-asset. Wenn Sie Notizenbücher in Dataplex durch Anmerkungen zu Notizenbuch-Einträgen mit Aspekten ergänzen möchten, rufen Sie den Aspekttyp dataform-code-asset auf, filtern Sie die Ergebnisse mit einem aspektbasierten Filter und setzen Sie das Feld type im Aspekt dataform-code-asset auf NOTEBOOK. Eine Anleitung zum Anhängen von Aspekten an Einträge finden Sie in der Dataplex-Dokumentation unter Aspekte verwalten und Metadaten anreichern.

Typ

Der Typ für Datenkanäle ist NOTEBOOK. Mit diesem Typ können Sie Notizen vom Systemeintragstyp dataform-code-asset und vom Aspekttyp dataform-code-asset filtern, indem Sie die Abfrage aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK in einem aspektbasierten Filter verwenden.

Eine Anleitung zum Suchen nach Assets in Dataplex finden Sie in der Dataplex-Dokumentation unter Nach Datenassets in Dataplex suchen.

Fehlerbehebung

Weitere Informationen finden Sie unter Fehlerbehebung bei Colab Enterprise.

Nächste Schritte

• Weitere Informationen zu Colab Enterprise-Notebooks in BigQuery
• Notebooks erstellen
• Weitere Informationen zum Orchestrating von Notebooks