Gérer les notebooks

Ce document explique comment gérer des notebooks Colab Enterprise dans BigQuery, y compris comment afficher, comparer, restaurer et supprimer des notebooks.

Ce document explique également comment afficher et gérer les métadonnées des notebooks dans Dataplex Universal Catalog.

Les notebooks sont des composants de code BigQuery Studio fournis par Dataform.

Avant de commencer

1. Créez un notebook.
2. Pour gérer les métadonnées des notebooks dans Dataplex Universal Catalog, assurez-vous que l'API Dataplex est activée dans votre projet Trusted Cloud .

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.

Pour gérer les métadonnées des notebooks dans Dataplex Universal Catalog, assurez-vous de disposer des rôles Dataplex Universal Catalog requis.

Accorder l'accès aux notebooks

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

1. Dans la console Trusted 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 more_vert 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.

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.

1. Dans la console Trusted 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 more_vert 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 Trusted Cloud , accédez à la page BigQuery.

   Accéder à BigQuery

2. Dans le volet Explorateur, cliquez sur le bouton more_vert 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 Trusted 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

Vous pouvez choisir de créer un notebook à l'intérieur ou à l'extérieur d'un dépôt. La gestion des versions des notebooks varie selon leur emplacement.

Gestion des versions de notebooks dans les dépôts

Les dépôts sont des dépôts Git qui résident dans BigQuery ou chez un fournisseur tiers. Vous pouvez utiliser des espaces de travail dans les dépôts pour effectuer le contrôle des versions sur les notebooks. Pour en savoir plus, consultez Utiliser le contrôle des versions avec un fichier.

Gestion des versions des notebooks en dehors des dépôts

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 Trusted 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'historique des versions.

3. Pour afficher la liste des versions du notebook par ordre décroissant de date, cliquez sur schedule Historique des versions.

Comparer les versions de notebook

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

1. Dans la console Trusted 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. Cliquez sur schedule Historique des versions.

4. Cliquez sur more_vert Afficher les actions à côté d'une version de notebook, puis sur Comparer. Le volet de comparaison s'ouvre. Il compare la version du notebook que vous avez sélectionnée avec la version actuelle du notebook.

5. Facultatif : Pour comparer les versions de manière intégrée plutôt que dans des volets distincts, cliquez sur Comparer, puis sur Intégré.

6. Facultatif : Pour comparer le code source des versions, cliquez sur Comparer, puis sur Afficher la source brute.

7. Facultatif : Pour masquer le résultat de la commande dans le notebook, cliquez sur Comparer, puis désélectionnez Afficher le résultat.

Restaurer une version de notebook

La restauration d'une version de notebook à partir du volet de comparaison 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.

1. Dans la console Trusted 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. Cliquez sur schedule Historique des versions.

4. Cliquez sur more_vert Afficher les actions à côté de la version, puis sur Comparer. Le volet de comparaison s'ouvre. Il compare la version du notebook que vous avez sélectionnée avec la version du notebook la plus récente.

5. Si vous souhaitez restaurer la version précédente du notebook après la comparaison, cliquez sur Restaurer.

6. Cliquez sur Confirmer.

Télécharger un notebook

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

1. Dans la console Trusted 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 Trusted 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 more_vert 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.

Gérer les métadonnées dans Dataplex Universal Catalog

Dataplex Universal Catalog vous permet de stocker et de gérer les métadonnées des notebooks. Les notebooks sont disponibles dans Dataplex Universal Catalog par défaut, sans configuration supplémentaire.

Vous pouvez utiliser Dataplex Universal Catalog pour gérer les notebooks dans tous les emplacements BigQuery. La gestion des notebooks dans Dataplex Universal Catalog est soumise aux quotas et limites de Dataplex Universal Catalog et aux tarifs de Dataplex Universal Catalog.

Dataplex Universal Catalog récupère automatiquement les métadonnées suivantes à partir des notebooks :

• Nom de l'élément de données
• Parent de l'élément de données
• Emplacement de l'élément de données
• Type d'élément de données
• Projet Trusted Cloud correspondant

Dataplex Universal Catalog enregistre les notebooks en tant qu'entrées avec les valeurs d'entrée suivantes :

Groupe d'entrées système

Le groupe d'entrées système pour les notebooks est @dataform. Pour afficher les détails des entrées de notebooks dans Dataplex Universal Catalog, vous devez afficher le groupe d'entrées du système dataform. Pour savoir comment afficher la liste de toutes les entrées d'un groupe d'entrées, consultez Afficher les détails d'un groupe d'entrées dans la documentation Dataplex Universal Catalog.

Type d'entrée système

Le type d'entrée système pour les notebooks est dataform-code-asset. Pour afficher les détails des notebooks, vous devez afficher le type d'entrée système dataform-code-asset, filtrer les résultats avec un filtre basé sur les aspects et définir le champ type dans l'aspect dataform-code-asset sur NOTEBOOK. Sélectionnez ensuite une entrée du notebook sélectionné. Pour savoir comment afficher les détails d'un type d'entrée sélectionné, consultez Afficher les détails d'un type d'entrée dans la documentation Dataplex Universal Catalog. Pour savoir comment afficher les détails d'une entrée sélectionnée, consultez Afficher les détails d'une entrée dans la documentation Dataplex Universal Catalog.

Type d'aspect du système

 Le type d'aspect système pour les notebooks est dataform-code-asset. Pour fournir un contexte supplémentaire aux notebooks dans Dataplex Universal Catalog en annotant les entrées de notebook avec des aspects, affichez le type d'aspect dataform-code-asset, filtrez les résultats avec un filtre basé sur les aspects et définissez le champ type dans l'aspect dataform-code-asset sur NOTEBOOK. Pour savoir comment annoter des entrées avec des aspects, consultez Gérer les aspects et enrichir les métadonnées dans la documentation Dataplex Universal Catalog.

Type

Le type de canevas de données est NOTEBOOK. Ce type vous permet de filtrer les notebooks dans le type d'entrée système dataform-code-asset et le type d'aspect dataform-code-asset à l'aide de la requête aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK dans un filtre basé sur les aspects.

Pour savoir comment rechercher des composants dans Dataplex Universal Catalog, consultez Rechercher des éléments de données dans Dataplex Universal Catalog dans la documentation Dataplex Universal Catalog.

Dépannage

Pour en savoir plus, consultez 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.
• Découvrez comment planifier des notebooks.