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 Knowledge Catalog ansehen und verwalten.

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

Hinweis

1. Notebook erstellen
2. Wenn Sie Notebook-Metadaten in Knowledge Catalog verwalten möchten, muss die Dataplex API in Ihrem Projekt in Google Cloud 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 Knowledge Catalog verwalten möchten, benötigen Sie die erforderlichen Knowledge Catalog-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. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

   Wenn der linke Bereich nicht angezeigt wird, klicken Sie auf Linken Bereich maximieren, um ihn zu öffnen.

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Suchen Sie das Notebook, auf das Sie Zugriff gewähren möchten.

5. Klicken Sie neben dem Notebook auf Aktionen öffnen und dann auf Freigeben.

6. Klicken Sie im Bereich Berechtigungen freigeben auf Nutzer/Gruppe hinzufügen.

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

8. 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.

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

10. Klicken Sie auf Speichern.

11. 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. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

   Wenn der linke Bereich nicht angezeigt wird, klicken Sie auf Linken Bereich maximieren, um ihn zu öffnen.

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Suchen Sie den Ordner, den Sie umbenennen möchten. Sie können die Suchfunktion oder Filter verwenden, um Ihr Notebook zu finden.

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

6. 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. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

   Wenn der linke Bereich nicht angezeigt wird, klicken Sie auf Linken Bereich maximieren, um ihn zu öffnen.

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf das Notebook, für das Sie das Speichern der Ausgabe deaktivieren möchten.

5. Wenn Sie die Menüleiste maximieren möchten, klicken Sie auf keyboard_arrow_down Sichtbarkeit der Kopfzeile ein-/ausblenden.

6. Klicken Sie auf Bearbeiten > Notebook-Einstellungen.

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

8. Klicken Sie auf Speichern.

9. 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.

Alle Notebooks ansehen

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

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

   Wenn der linke Bereich nicht angezeigt wird, klicken Sie auf Linken Bereich maximieren, um ihn zu öffnen.

3. 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. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf den Namen des Notebooks, für das Sie Metadaten aufrufen möchten.

5. In den Zusammenfassungsdetails 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

Sie können ein Notebook entweder innerhalb oder außerhalb eines Repositorys erstellen. Die Notebook-Versionsverwaltung wird je nach Speicherort des Notebooks unterschiedlich gehandhabt.

Notebook-Versionsverwaltung in Repositories

Repositories sind Git-Repositories, die sich entweder in BigQuery oder bei einem Drittanbieter befinden. Sie können Arbeitsbereiche in Repositories verwenden, um die Versionsverwaltung für Notebooks durchzuführen. Weitere Informationen finden Sie unter Versionsverwaltung für eine Datei verwenden.

Notebook-Versionsverwaltung außerhalb von Repositories

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

Notebook-Versionen ansehen

So rufen Sie Notebook-Versionen auf:

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks. Klicken Sie auf den Namen des Notebooks, für das Sie den Versionsverlauf aufrufen möchten.

4. Klicken Sie auf Versionsverlauf, um eine Liste der Notebook-Versionen in absteigender Reihenfolge nach Datum aufzurufen.

Notebook-Versionen vergleichen

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

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf den Namen des Notebooks, für das Sie die Versionsinformationen vergleichen möchten.

5. Klicken Sie auf Versionsverlauf.

6. 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 aktuellen Notebookversion verglichen.

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

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

9. 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

Wenn Sie eine Notebookversion ü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. Es geht kein Versionsverlauf verloren.

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf den Namen des Notebooks, von dem Sie eine vorherige Version wiederherstellen möchten.

5. Klicken Sie auf Versionsverlauf.

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

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

8. Klicken Sie auf Bestätigen.

Notebook umbenennen

So benennen Sie ein Notebook um:

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf das Notebook, das Sie umbenennen möchten.

5. Klicken Sie auf keyboard_arrow_down Sichtbarkeit der Kopfzeile ein-/ausblenden, um die Menüleiste zu maximieren.

6. Klicken Sie auf Datei > Umbenennen.

7. Geben Sie im Dialogfeld Notebook umbenennen einen Namen für das Notebook ein und klicken Sie dann auf Umbenennen.

Notebook herunterladen

So laden Sie ein Notebook herunter:

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Klicken Sie auf den Namen des Notebooks, das Sie herunterladen möchten. Sie können die Suchfunktion oder Filter verwenden, um Ihr Notebook zu finden.

5. Maximieren Sie die Menüleiste und rufen Sie das Menü Datei auf:

   

6. Wählen Sie Herunterladen und dann den Dateityp aus, in dem Sie die Datei herunterladen möchten.

Notebooks löschen

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

1. Rufen Sie in der Google Cloud Console die Seite BigQuery auf.

   BigQuery aufrufen

2. Klicken Sie im linken Bereich auf Explorer:

   

3. Maximieren Sie im Bereich Explorer Ihr Projekt und klicken Sie auf Notebooks.

4. Suchen Sie den Ordner, den Sie löschen möchten.

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

6. Geben Sie im Dialogfeld delete ein, um den Löschvorgang zu bestätigen.

7. Klicken Sie auf Löschen.

Metadaten in Knowledge Catalog verwalten

Mit Knowledge Catalog können Sie Metadaten für Notebooks speichern und verwalten. Notebooks sind standardmäßig in Knowledge Catalog verfügbar, ohne dass eine zusätzliche Konfiguration erforderlich ist.

Mit Knowledge Catalog können Sie Notebooks an allen BigQuery-Standorten verwalten. Für die Verwaltung von Notebooks in Knowledge Catalog gelten die Kontingente und Limits für Knowledge Catalog sowie die Knowledge Catalog-Preise.

Knowledge Catalog 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

Knowledge Catalog protokolliert Notebooks als Einträge mit den folgenden Eintragswerten:

Systemeintragsgruppe

Die Systemeintragsgruppe für Notebooks ist @dataform. Wenn Sie Details zu Notebook-Einträgen in Knowledge Catalog 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 Knowledge Catalog-Dokumentation unter Details einer Eintragsgruppe ansehen.

Systemeintragstyp

Der Systemeintragstyp für Notebooks ist dataform-code-asset. Wenn Sie Details zu Notebooks 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 im ausgewählten Notebook aus. Eine Anleitung zum Aufrufen von Details eines ausgewählten Eintragstyps finden Sie in der Knowledge Catalog-Dokumentation unter Details eines Eintragstyps aufrufen. Eine Anleitung zum Aufrufen der Details eines ausgewählten Eintrags finden Sie in der Knowledge Catalog-Dokumentation unter Details eines Eintrags aufrufen.

Systemaspekttyp

Der Systemaspekttyp für Notebooks ist dataform-code-asset. Wenn Sie Notebooks in Knowledge Catalog zusätzlichen Kontext hinzufügen möchten, indem Sie Notebook-Einträge mit Aspekten annotieren, 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 Annotieren von Einträgen mit Aspekten finden Sie in der Knowledge Catalog-Dokumentation unter Aspekte verwalten und Metadaten anreichern.

Typ

Der Typ für Daten-Canvases ist NOTEBOOK. Mit diesem Typ können Sie Notebooks im Systemeintragstyp dataform-code-asset und im 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 Knowledge Catalog finden Sie in der Knowledge Catalog-Dokumentation unter Nach Daten-Assets in Knowledge Catalog suchen.

Fehlerbehebung

Weitere Informationen finden Sie unter Fehlerbehebung bei Colab Enterprise.

Nächste Schritte

• Weitere Informationen zu Colab Enterprise-Notebooks in BigQuery
• Notebooks erstellen
• Notebooks planen