Supprimer des données de manière groupée

Utilisez le service de suppression groupée géré pour supprimer des données de votre base de données. Cette fonctionnalité permet de supprimer un ou plusieurs groupes de collections.

Cette page explique comment supprimer des documents par lot à l'aide du service de suppression par lot géré. Le service de suppression groupée géré Cloud Firestore est disponible via l'outil de ligne de commande gcloud et l'API REST Cloud Firestore.

Avant de commencer

Pour pouvoir utiliser le service de suppression groupée géré, vous devez effectuer les tâches ci-dessous :

  1. Activez la facturation pour votre projet Google Cloud. Seuls les projets Google Cloud pour lesquels la facturation est activée peuvent utiliser la fonctionnalité de suppression groupée.

  2. Assurez-vous que votre compte dispose des autorisations nécessaires pour Cloud Firestore. Si vous êtes le propriétaire du projet, votre compte dispose des autorisations requises. Sinon, les rôles suivants accordent les autorisations nécessaires pour les opérations de suppression groupée :

    • Rôles Cloud Firestore : Owner, Cloud Datastore Owner ou Cloud Datastore Bulk Admin

Configurer gcloud pour votre projet

Vous pouvez lancer des opérations de suppression groupée via la console Google Cloud ou l'outil de ligne de commande gcloud. Pour utiliser gcloud, configurez l'outil de ligne de commande et connectez-vous à votre projet de l'une des manières suivantes :

Supprimer des données de manière groupée

Une opération de suppression groupée recherche d'abord tous les documents applicables dans votre base de données, puis les supprime par lots. Vous pouvez toujours interroger ou lire ces documents, mais les résultats peuvent varier en fonction des progrès réalisés. La suppression groupée ne supprime aucun document ajouté ou modifié après le début de l'opération.

Supprimer des groupes de collections spécifiques de manière groupée

gcloud

Pour supprimer des groupes de collections spécifiques de manière groupée, utilisez l'indicateur --collection-ids. L'opération ne supprime que les groupes de collections avec les ID saisis. Un groupe de collections inclut tous les documents et documents imbriqués (à n'importe quel chemin d'accès) avec les groupes de collections spécifiés. 

gcloud firestore bulk-delete \
--collection-ids=[COLLECTION_GROUP_ID_1_OR_KIND_1],[COLLECTION_GROUP_ID_2_OR_KIND_2],[SUBCOLLECTION_GROUP_ID_1_OR_KIND_3] \
--database=[DATABASE]
Par exemple, imaginez plusieurs documents représentant des restaurants dans la collection restaurants de premier niveau de la base de données cymbal. Sous chaque document de restaurant, il existe plusieurs sous-collections imbriquées telles que ratings, reviews et outlets. Pour supprimer en masse les groupes de collections restaurants et reviews, votre commande se présente comme suit :

gcloud firestore bulk-delete \
--collection-ids=restaurants,reviews \
--database='cymbal'

Gérer les opérations de suppression groupée

Une fois que vous avez lancé une opération de suppression groupée, Cloud Firestore attribue à l'opération un nom unique. Vous pouvez utiliser le nom de l'opération pour supprimer, annuler ou vérifier l'état de l'opération.

Les noms des opérations sont précédés du préfixe projects/[PROJECT_ID]/databases/[DATABASE_ID]/operations/, par exemple :

projects/my-project/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Cependant, vous pouvez omettre le préfixe lorsque vous spécifiez un nom d'opération pour les commandes describe, cancel et delete.

Lister toutes les opérations de suppression groupée

gcloud

Utilisez la commande operations list pour afficher toutes les opérations en cours et terminées récemment, y compris les opérations de suppression groupée :

gcloud firestore operations list

Vérifier l'état de l'opération

gcloud

Utilisez la commande operations describe pour afficher l'état d'une opération de suppression groupée.

gcloud firestore operations describe [OPERATION_NAME]

Estimer le délai d'exécution

Une requête permettant d'obtenir l'état d'une opération de longue durée renvoie les métriques workEstimated et workCompleted. Chacune de ces métriques est renvoyée à la fois en nombre d'octets et en nombre de documents :

  • workEstimated indique le nombre total estimé d'octets et de documents qu'une opération va traiter. Cloud Firestore peut omettre cette métrique s'il ne peut pas faire d'estimation.

  • workCompleted indique le nombre d'octets et de documents supprimés jusqu'à présent. Une fois l'opération terminée, la valeur indique le nombre total d'octets et de documents réellement traités, qui peut être supérieur à la valeur de workEstimated.

Divisez workCompleted par workEstimated pour obtenir une estimation approximative de la progression. Cette estimation peut être inexacte, car elle dépend de la collecte de statistiques retardée.

Annuler une opération

gcloud

Utilisez la commande operations cancel pour arrêter une opération en cours :

gcloud firestore operations cancel [OPERATION_NAME]

L'annulation d'une opération en cours n'annule pas l'opération. L'annulation d'une opération de suppression groupée n'entraîne pas la récupération des documents supprimés.

Supprimer une opération

Utilisez la commande gcloud firestore operations delete pour supprimer une opération terminée de la liste des opérations récentes. Pour annuler une opération en cours, utilisez l'opération d'annulation précédente.

gcloud firestore operations delete [OPERATION_NAME]

Facturation et tarifs des opérations de suppression groupée

Vous devez activer la facturation pour votre projet Google Cloud avant d'utiliser le service de suppression groupée géré.

Les opérations de suppression groupée sont facturées pour les lectures et suppressions de documents aux tarifs indiqués dans la section Tarifs de Cloud Firestore. Les opérations de suppression groupée entraînent une lecture d'entrée d'index par document trouvé et une opération de suppression par document supprimé. Une opération de lecture vous est facturée pour un maximum de 1 000 entrées d'index lues. Par exemple, pour une opération de suppression groupée qui a supprimé 1 500 documents, vous serez facturé pour deux lectures de documents et 1 500 suppressions de documents.

Notez que Cloud Firestore facture le travail réellement effectué. Si l'opération est annulée ou échoue en raison d'une erreur de l'utilisateur, vous serez facturé en fonction des progrès réalisés. Cloud Firestore ne facture pas les lectures ni les suppressions pour les documents qui ne sont pas supprimés, par exemple les documents modifiés après le début de l'opération de suppression. Le coût sera attribué le jour de la finalisation de l'opération.

Les opérations de suppression groupée ne déclenchent pas vos alertes budgétaires Google Cloud avant la fin de leur exécution. De même, les opérations de lecture et de suppression effectuées lors d'une opération de suppression groupée sont appliquées à votre utilisation du forfait gratuit une fois l'opération terminée. Les opérations de suppression groupée n'ont aucune incidence sur l'utilisation affichée dans la section "Utilisation" de la console.

Afficher les coûts de la suppression groupée

Les opérations de suppression groupée appliquent le libellé goog-firestoremanaged:bulkdelete aux opérations facturées. Sur la page Rapports Cloud Billing, vous pouvez utiliser ce libellé pour afficher les coûts liés aux opérations de suppression groupée.

Bonnes pratiques

Évitez d'ignorer les données supprimées, car cela pourrait ralentir les requêtes.