Gérer la conservation des données avec les index TTL

Cette page explique comment utiliser l'API MongoDB, la console Google Cloud et Google Cloud CLI pour configurer des index TTL (Time To Live).

Présentation de la valeur TTL

Utilisez des index TTL pour supprimer automatiquement les données obsolètes de vos bases de données. Un index TTL désigne un champ donné comme délai d'expiration des documents d'une collection donnée. Avec la valeur TTL, vous pouvez réduire les coûts de stockage en supprimant les données obsolètes. Les données sont généralement supprimées dans les 24 heures suivant leur délai d'expiration.

Tarifs

Les opérations de suppression TTL sont comptabilisées dans vos coûts de suppression de documents. Pour connaître les tarifs des opérations de suppression, consultez la page Tarifs de l'édition Cloud FirestoreEnterprise.

Limites et contraintes

• Vous ne pouvez créer qu'un seul index TTL par collection.
• Vous pouvez avoir un maximum de 500 index TTL.

Suppression TTL

Notez les comportements clés suivants de la suppression basée sur la valeur TTL :

• La suppression via la valeur TTL n'est pas un processus instantané. Les documents expirés continuent d'apparaître dans les requêtes et les demandes de recherche jusqu'à ce que le processus TTL les supprime réellement. La valeur TTL échange la rapidité de suppression au profit d'une réduction du coût total de possession pour les suppressions. Les données sont généralement supprimées dans les 24 heures suivant leur délai d'expiration.

• La création d'un index TTL sur une collection existante entraîne une suppression groupée de toutes les données expirées en fonction du nouvel index TTL. Notez que cette suppression groupée n'est pas non plus instantanée et dépend de la quantité de données existantes pour cette collection.

• Si un document a un délai d'expiration dans le passé et que vous ajoutez un nouvel index TTL à la collection, le document sera supprimé dans les 24 heures suivant la fin de la configuration et l'activation de l'index TTL.

• La valeur TTL ne supprime pas nécessairement les documents dans le même ordre que leurs codes temporels d'expiration.

• Les suppressions ne sont pas effectuées de manière transactionnelle. Les documents ayant le même délai d'expiration ne sont pas nécessairement supprimés en même temps. Si vous avez besoin de ce comportement, effectuez les suppressions à l'aide d'une bibliothèque cliente.

• Cloud Firestore respectera toujours le dernier champ TTL pour déterminer le délai d'expiration. Par exemple, si le champ TTL d'un document expiré mais non encore supprimé est mis à jour à une date ultérieure, le document n'expirera pas et la nouvelle date sera utilisée.

• Cloud Firestore n'expire un document que lorsque le champ TTL est défini sur une valeur Date and time/BSON Date ou sur une valeur Array contenant une valeur Date and time/BSON Date. Laissez le champ absent ou défini sur une valeur telle que null pour désactiver les expirations par document.

• La valeur TTL est conçue pour minimiser l'impact sur les autres activités de base de données. Les suppressions basées sur la valeur TTL sont traitées avec une priorité inférieure. D'autres stratégies sont également en place pour lisser les pics de trafic dus aux suppressions basées sur la valeur TTL.

Champs TTL et index non TTL

Un champ TTL peut être indexé ou non. Toutefois, comme un champ TTL est un code temporel, l'inclusion du champ dans un index non TTL peut affecter les performances à des taux de trafic plus élevés. L'inclusion d'un champ de code temporel dans un index non TTL peut créer des hotspots, ce qui n'est pas recommandé. Les hotspots sont des taux de lecture, d'écriture et de suppression élevés pour une plage de documents restreinte.

Autorisations

Le principal qui crée ou supprime un index TTL nécessite l'autorisation suivante dans le projet :

• L'affichage des index TTL nécessite les autorisations datastore.indexes.list et datastore.indexes.get.
• La création ou la suppression d'index TTL nécessite l'autorisation datastore.indexes.update.
• La vérification de l'état des opérations TTL nécessite datastore.operations.list et datastore.operations.get.

Pour connaître les rôles qui attribuent ces autorisations, consultez la section Cloud Firestore Rôles Identity and Access Management.

Avant de commencer

Avant d'utiliser le gcloud CLI pour gérer les index TTL, utilisez la gcloud components update commande pour mettre à jour les composants vers la dernière version disponible :

gcloud components update

Créer un index TTL

Lorsque vous créez un index TTL, vous désignez un champ de document comme délai d'expiration des documents d'une collection.

La valeur TTL utilise un champ spécifié pour identifier les documents éligibles à la suppression. Le champ TTL doit être défini sur une valeur Timestamp/BSON Date ou sur une valeur Array contenant une valeur Timestamp/BSON Date. Vous pouvez sélectionner un champ qui existe déjà ou en désigner un que vous prévoyez d'ajouter ultérieurement.

Tenez compte des points suivants avant de définir la valeur du champ TTL :

• La valeur du champ TTL peut être une heure future, actuelle ou passée. Si la valeur est une heure passée, le document est immédiatement éligible à la suppression. Par exemple, vous pouvez créer un index TTL avec le champ expireAt, que vous ajoutez ensuite aux documents existants.

• L'utilisation de tout autre type de données ou la non-définition de la valeur du champ TTL désactiveront la valeur TTL pour le document individuel.

Pour créer un index TTL, procédez comme suit :

db.COLLECTION_NAME.createIndex({"TTL_FIELD": 1, "expireAfterSeconds": EXPIRATION_OFFSET_SECONDS})

db.restaurants.createIndex({"ts": 1, "expireAfterSeconds": 3600})

Durée de création d'un index TTL

Même sur une base de données vide, la création d'un index TTL peut prendre au moins dix minutes. Une fois que vous avez démarré une opération, la fermeture du terminal ne l'annule pas.

Afficher les index TTL

Pour afficher les index TTL, procédez comme suit :

db.restaurants.listIndexes()

Afficher les détails de l'opération

Vous pouvez utiliser la gcloud CLI pour afficher plus de détails sur un index TTL à l'état CREATING.

Utilisez la commande operations list pour afficher toutes les opérations en cours et récemment terminées :

gcloud firestore operations list

La réponse inclut une estimation de la progression de l'opération.

Supprimer un index TTL

Pour supprimer un index TTL, procédez comme suit :

db.restaurants.dropIndex("ts_1")

db.restaurants.dropIndex({"ts": 1})

Surveiller les suppressions TTL

Vous pouvez utiliser Cloud Monitoring pour afficher des métriques sur les suppressions basées sur la valeur TTL. Cloud Firestore fournit les métriques suivantes pour la valeur TTL :

Pour configurer un tableau de bord avec des métriques Cloud Firestore, consultez Gérer un tableau de bord personnalisé et Ajouter des widgets à un tableau de bord.