Gérer les notebooks

Remarque : La facturation des notebooks BigQuery Studio sera effective en disponibilité générale à compter du 11 avril 2024. Des frais basés sur l'utilisation pour les notebooks BigQuery Studio commenceront alors à apparaître sur votre facture.

Ce document explique comment gérer des notebooks Colab Enterprise dans BigQuery. Les notebooks sont des composants de code BigQuery Studio fournis par Dataform.

Pour utiliser des notebooks, vous devez d'abord activer BigQuery Studio pour la gestion des éléments.

Important : En mars 2024, les API compatibles avec les fonctionnalités de BigQuery Studio ont été automatiquement activées pour tous les projets BigQuery existants. Ces API sont activées par défaut dans les nouveaux projets BigQuery. Pour en savoir plus, consultez la section Activation automatique des API BigQuery Studio.

Autorisations requises

Pour partager les notebooks, vous avez besoin des rôles IAM (Identity and Access Management) suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)
• Propriétaire de code (roles/dataform.codeOwner) au niveau de la ressource

Pour enregistrer et supprimer des notebooks, vous avez besoin des rôles IAM suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)
• Propriétaire de code (roles/dataform.codeOwner) ou Éditeur de code (roles/dataform.codeEditor)

Pour utiliser des révisions de notebook, vous avez besoin des rôles IAM suivants :

• Utilisateur de job BigQuery (roles/bigquery.jobUser)
• Utilisateur de sessions de lecture BigQuery (roles/bigquery.readSessionUser)

• L'un des rôles suivants :

  • Propriétaire de code (roles/dataform.codeOwner)
  • Éditeur de code (roles/dataform.codeEditor)
  • Lecteur de code (roles/dataform.codeViewer)

Pour plus d'informations sur BigQuery IAM, consultez la page Contrôle des accès avec IAM.

Accorder l'accès aux notebooks

Pour accorder à d'autres utilisateurs l'accès à un notebook, ajoutez-les à un rôle IAM approprié.

Important : Les utilisateurs ayant accès au notebook peuvent voir tous les résultats générés par le code dans le notebook, même si ces résultats contiennent des données de tables auxquelles ils n'ont pas accès. Pour empêcher le partage de la sortie enregistrée, désactivez l'enregistrement de la sortie du notebook.

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Recherchez le notebook auquel vous souhaitez accorder l'accès.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Partager > Gérer les autorisations.

4. Dans le volet Gérer les autorisations, cliquez sur Ajouter un utilisateur/groupe.

5. Dans le champ Nouveaux comptes principaux, saisissez un compte principal.

6. Dans la liste Rôle, sélectionnez l'un des rôles suivants :

   • Propriétaire de code : peut effectuer n'importe quelle action sur le notebook, y compris le supprimer ou le partager.
   • Éditeur de code : peut modifier le notebook.
   • Lecteur de code : peut afficher le notebook.
   Remarque : Le compte principal doit également disposer des rôles Utilisateur de l'environnement d'exécution de notebook (roles/aiplatform.notebookRuntimeUser) et Utilisateur BigQuery (roles/bigquery.user) pour exécuter le notebook.

7. Facultatif : Pour afficher la liste complète des rôles et des paramètres de partage avancés, cliquez sur Partage avancé.

8. Cliquez sur Enregistrer.

9. Pour revenir à la page d'informations sur le notebook, cliquez sur Fermer.

Partager des notebooks

Pour partager un notebook avec d'autres utilisateurs, vous pouvez générer et partager un lien vers celui-ci. Pour que les autres utilisateurs puissent voir le notebook que vous partagez, vous devez d'abord accorder l'accès au notebook.

Pour exécuter un notebook, les utilisateurs doivent avoir accès aux données auxquelles le notebook accède. Pour en savoir plus, consultez la section Accorder l'accès à un ensemble de données.

Important : Les utilisateurs ayant accès au notebook peuvent voir tous les résultats générés par le code dans le notebook, même si ces résultats contiennent des données de tables auxquelles ils n'ont pas accès. Pour empêcher le partage de la sortie enregistrée, désactivez l'enregistrement de la sortie du notebook.

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Recherchez le notebook que vous souhaitez partager.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Partager > Copier le lien.

4. Partagez le lien avec d'autres utilisateurs.

Afficher tous les notebooks

Pour afficher la liste de tous les notebooks de votre projet, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, cliquez sur le bouton Afficher les actions en regard de Notebooks, puis effectuez l'une des opérations suivantes :

• Pour ouvrir la liste dans l'onglet actuel, cliquez sur Tout afficher.
• Pour ouvrir la liste dans un nouvel onglet, cliquez sur Tout afficher dans > Nouvel onglet.
• Pour ouvrir la liste dans un onglet divisé, cliquez sur Tout afficher dans > Diviser l'onglet.

Afficher les métadonnées du notebook

Pour afficher les métadonnées du notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez afficher les métadonnées.

3. Consultez le volet Résumé pour afficher des informations sur le notebook, telles que la région qu'il utilise pour les données et la date de sa dernière modification.

Utiliser les versions de notebook

Utilisez les sections suivantes pour savoir comment afficher, comparer et restaurer les versions d'un notebook.

Afficher les versions de notebook

Pour afficher les versions de notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez afficher l'activité.

3. Cliquez sur l'onglet Activité pour afficher la liste des versions de notebook par ordre décroissant de date.

Comparer les versions de notebook

Pour comparer les versions de notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook pour lequel vous souhaitez comparer les informations de version.

3. Dans l'onglet Activité, cliquez sur le bouton Afficher les actions en regard d'une version de notebook, puis sur Comparer.

4. Dans le volet Historique des révisions, utilisez les listes déroulantes dans Version pour choisir les versions à comparer.

5. Facultatif : Pour comparer le code source du notebook, cochez la case Source brute.

6. Facultatif : Pour comparer les versions de manière intégrée plutôt que dans des volets distincts, cochez la case Différences intégrées.

7. Facultatif : Pour masquer le résultat de la commande dans le notebook, décochez la case Afficher le résultat.

Restaurer une version de notebook

Utilisez l'une des options suivantes pour restaurer une version de notebook. La restauration à partir du volet Historique des révisions vous permet de comparer les versions actuelles et précédentes d'un notebook avant de choisir de restaurer la version précédente. La restauration d'un notebook crée une nouvelle version au lieu de l'écraser. L'historique des versions n'est pas perdu.

Volet Activité

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez restaurer une version précédente.

3. Sélectionnez le volet Activité.

4. Cliquez sur le bouton Afficher les actions en regard de la version de notebook que vous souhaitez restaurer, puis cliquez sur Restaurer.

5. Cliquez sur Confirm (Confirmer).

Historique des révisions

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Cliquez sur le nom du notebook dont vous souhaitez restaurer une version précédente.

3. Sélectionnez le volet Activité.

4. Cliquez sur Afficher les actions à côté d'une version de notebook, puis sur Comparer.

5. Dans le volet Historique des révisions, cliquez sur le bouton Afficher les actions en regard de la liste déroulante Version, puis sur Restaurer la révision

6. Cliquez sur Confirm (Confirmer).

Télécharger un notebook

Procédez comme suit pour télécharger un notebook :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks et, si nécessaire, le dossier Notebooks partagés. Cliquez sur le nom du notebook que vous souhaitez télécharger.

3. Cliquez sur Download (Télécharger).

Supprimer des notebooks

Pour supprimer un notebook, procédez comme suit :

1. Dans la console Google Cloud, accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, développez votre projet et le dossier Notebooks, et développez si nécessaire le dossier Notebooks partagés. Recherchez le notebook que vous souhaitez supprimer.

3. Cliquez sur le bouton Afficher les actions en regard du notebook, puis sur Supprimer.

4. Pour confirmer la suppression, saisissez delete dans la boîte de dialogue.

5. Cliquez sur Supprimer.

Dépannage

Pour en savoir plus, consultez la page Résoudre les problèmes liés à Colab Enterprise.

Étapes suivantes

• Apprenez-en plus sur les notebooks Colab Enterprise dans BigQuery.
• Apprenez à créer des notebooks.