Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Gérer la conservation des données avec des règles TTL

Cette page explique comment utiliser Google Cloud Console et Google Cloud CLI pour configurer des règles de valeur TTL (Time To Live). Avant de lire cette page, vous devez comprendre le modèle de données Firestore.

Aperçu de la valeur TTL

Utilisez des règles de valeur TTL (Time To Live) pour supprimer automatiquement les données obsolètes de vos bases de données. Une règle TTL désigne un champ donné comme le délai d'expiration des documents d'un groupe de collections donné. La valeur TTL vous permet de réduire les coûts de stockage en éliminant les données obsolètes. Les données sont généralement supprimées dans les 72 heures suivant leur date d'expiration.

Tarifs

Les opérations de suppression TTL sont comptabilisées dans les coûts de suppression du document. Pour connaître le prix des opérations de suppression, consultez la page Tarifs de Firestore.

Limites et contraintes

  • Un seul champ par groupe de collections peut être marqué comme champ TTL.
  • Un total de 200 configurations au niveau du champ est autorisé. Une même configuration de champ peut contenir plusieurs configurations pour le même champ. Par exemple, une exception d'indexation à champ unique et une règle TTL pour un même champ comptent pour une configuration de champ dans la limite.

Suppression de la valeur TTL

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

  • La suppression via la valeur TTL n'est pas un processus instantané. Les documents arrivés à expiration continuent d'apparaître dans les requêtes et les requêtes de recherche jusqu'à ce que le processus TTL les supprime. La valeur TTL est fixée au moment de la suppression, au profit d'un coût total de possession réduit. Les données sont généralement supprimées dans les 72 heures suivant leur date d'expiration.

  • L'application d'une règle TTL à un groupe de collections existant entraîne la suppression groupée de toutes les données expirées conformément à la nouvelle règle TTL. Notez que cette suppression groupée n'est pas instantanée et dépend de la quantité de données qui existe pour ce groupe de collections.

  • La valeur TTL ne supprime pas nécessairement les documents dans le même ordre que leurs horodatages 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.

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

  • La valeur TTL est conçue pour minimiser l'impact sur les autres activités de base de données. Les suppressions générées par 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 provenant des suppressions basées sur la valeur TTL.

  • La suppression via la valeur TTL appelle tous les écouteurs d'instantanés actifs et déclenche des déclencheurs Cloud Functions Firestore.

Champs et index des valeurs TTL

Un champ TTL peut être indexé ou non indexé. Toutefois, comme un champ TTL est un horodatage, l'indexation du champ peut affecter les performances à des taux de trafic plus élevés. L'indexation d'un champ d'horodatage peut créer des zones cliquables, ce qui va à l'encontre des bonnes pratiques. Les zones cliquables sont des taux élevés de lecture, d'écriture et de suppression dans une plage de documents restreinte.

Par défaut, Firestore crée un index à champ unique pour tous les champs. Vous pouvez créer une exception d'index à champ unique pour désactiver les index sur un champ TTL.

Autorisations

Le compte principal qui configure une règle TTL nécessite l'autorisation suivante dans le projet:

  • Pour afficher les règles TTL, vous devez disposer des autorisations datastore.indexes.list et datastore.indexes.get.
  • L'autorisation datastore.indexes.update est nécessaire pour modifier les règles TTL.
  • Pour vérifier l'état des opérations TTL, vous devez utiliser datastore.operations.list et datastore.operations.get.

Pour les rôles qui attribuent ces autorisations, consultez Rôles IAM.

Avant de commencer

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

gcloud components update

Créer une règle TTL

Lorsque vous créez une règle TTL, vous désignez un champ de document comme délai d'expiration pour les documents d'un groupe de collections.

La valeur TTL utilise un champ spécifié pour identifier les documents pouvant être supprimés. Ce champ TTL doit être de type Date and time. Vous pouvez sélectionner un champ qui existe déjà ou désigner un champ que vous prévoyez d'ajouter ultérieurement. La valeur du champ "TTL" peut être une heure future, actuelle ou antérieure. Si la valeur correspond à une date antérieure, le document peut immédiatement être supprimé.

Par exemple, vous pouvez créer une règle TTL avec le champ expireAt, que vous ajoutez ensuite aux documents existants.

Pour créer une règle TTL, procédez comme suit:

Console Google Cloud

  1. Accédez à la page Valeur TTL de Firestore dans Google Cloud Console.

    Accéder à la page "Valeur TTL"

  2. Cliquez sur Créer une règle.

  3. Saisissez un nom de groupe de collections et un nom de champ d'horodatage.

  4. Cliquez sur Créer.

La page Time to Live s'affiche à nouveau. Si l'opération démarre correctement, la page ajoute une entrée au tableau des règles TTL. En cas d'échec, la page affiche un message d'erreur.

gcloud

Utilisez la commande firestore fields ttls update pour configurer une règle TTL. Ajoutez l'option --async pour empêcher gcloud CLI d'attendre la fin de l'opération.

gcloud beta firestore fields ttls update ttl_field --collection-group=collection_group_name --enable-ttl

Même dans une base de données vide, l'activation d'une règle TTL peut prendre 10 minutes ou plus. Une fois que vous avez démarré une opération, la fermeture du terminal n'annule pas l'opération.

Afficher les règles TTL

Suivez les étapes ci-dessous pour afficher les règles TTL et leur état.

Console Google Cloud

Accédez à la page Valeur TTL de Firestore dans Google Cloud Console.

Accéder à la page "Valeur TTL"

La console répertorie les règles TTL de votre base de données et inclut l'état de chaque règle.

gcloud

Utilisez la commande firestore fields ttls list pour configurer une règle TTL. La commande suivante répertorie toutes les règles TTL.

gcloud beta firestore fields ttls list

Pour répertorier les règles TTL d'un groupe de collections spécifique, utilisez le code suivant:

gcloud beta firestore fields ttls list  --collection-group=collection_group_name

Afficher les détails de l'opération

Vous pouvez utiliser gcloud CLI pour afficher plus de détails sur une règle TTL dont l'état est CREATING.

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

gcloud firestore operations list

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

Désactiver une règle TTL

Pour désactiver une règle TTL, procédez comme suit :

Console Google Cloud

  1. Accédez à la page Valeur TTL de Firestore dans Google Cloud Console.

    Accéder à la page "Valeur TTL"

  2. Dans le tableau des règles TTL, recherchez la ligne correspondante. Sur cette ligne du tableau, cliquez sur le bouton Supprimer (Corbeille).

  3. Confirmez l'opération en cliquant sur Supprimer.

La page Time to Live s'affiche à nouveau. En cas de réussite, Firestore supprime la règle TTL de la table.

gcloud

Utilisez la commande firestore fields ttls update pour configurer une règle TTL. Ajoutez l'option --async pour empêcher gcloud CLI d'attendre la fin de l'opération.

gcloud beta firestore fields ttls update ttl_field --collection-group=collection_group_name --disable-ttl

Surveiller les suppressions de valeurs TTL

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

firestore.googleapis.com/document/ttl_deletion_count Nombre de suppressions de durée de vie

Nombre total de documents supprimés par les règles TTL (Time To Live).

firestore.googleapis.com/document/ttl_expiration_to_deletion_delays Délai avant expiration de la suppression des demandes de suppression

Temps écoulé entre l'expiration d'un document soumis à une règle TTL (Time To Live) et sa suppression effective.

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