Utiliser la récupération à un moment précis (PITR)

Cette page explique comment utiliser la récupération à un moment précis (PITR) pour conserver et récupérer des données dans Cloud Firestore.

Pour comprendre les concepts de récupération à un moment précis, consultez Récupération à un moment précis.

Autorisations

Pour obtenir les autorisations nécessaires pour gérer les paramètres de PITR, demandez à votre administrateur de vous accorder les rôles IAM suivants sur le projet pour lequel vous souhaitez activer PITR:

  • Propriétaire Cloud Datastore (roles/datastore.owner)

Pour les rôles personnalisés, assurez-vous que les autorisations suivantes sont accordées:

  • Pour activer la récupération PITR lors de la création d'une base de données: datastore.databases.create
  • Pour mettre à jour les paramètres PITR sur une base de données existante: datastore.databases.update,datastore.databases.list
  • Pour effectuer des lectures à partir des données PITR: datastore.databases.get,datastore.entities.get,datastore.entities.list
  • Pour exporter des données PITR: datastore.databases.export
  • Pour importer des données PITR: datastore.databases.import

Avant de commencer

Notez les points suivants avant de commencer à utiliser PITR:

  • Vous ne pouvez pas commencer à lire des données remontant à sept jours en arrière immédiatement après avoir activé la récupération PITR.
  • Si vous souhaitez activer PITR lorsque vous créez une base de données, vous devez utiliser la commande gcloud firestore databases create. L'activation de PITR lors de la création d'une base de données à l'aide de la console Google Cloud n'est pas possible.
  • Cloud Firestore commence à conserver les versions à partir de ce point après l'activation de la récupération à un moment précis.
  • Vous ne pouvez pas lire les données PITR dans la fenêtre PITR après avoir désactivé la récupération PITR.
  • Si vous réactivez la récupération à un moment précis immédiatement après l'avoir désactivée, les données PITR précédentes ne sont plus disponibles. Toutes les données PITR créées avant la désactivation de la récupération PITR seront supprimées après la date d'expiration de la récupération PITR.
  • Si vous avez supprimé accidentellement des données au cours de la dernière heure et que la récupération à un moment précis est désactivée, vous pouvez restaurer vos données en activant la récupération à un moment précis dans l'heure suivant la suppression.
  • Toute lecture effectuée sur des données PITR expirées échoue.

Activer la récupération PITR

Avant d'utiliser PITR, activez la facturation pour votre projet Google Cloud. Seuls les projets Google Cloud pour lesquels la facturation est activée peuvent utiliser la fonctionnalité PITR.

Pour activer la récupération PITR pour votre base de données:

Console

  1. Dans la console Google Cloud, accédez à la page Base de données.

    Accéder à la page "Bases de données"

  2. Sélectionnez la base de données requise dans la liste des bases de données.

  3. Dans le menu de navigation, cliquez sur Reprise après sinistre.

  4. Cliquez sur Modifier pour modifier les paramètres.

  5. Cochez la case Activer la récupération à un moment précis, puis cliquez sur Enregistrer.

L'activation de PITR entraînerait des coûts de stockage. Reportez-vous à la page Tarifs pour plus de détails.

Pour désactiver la récupération à un moment précis, décochez la case Activer la récupération à un moment précis sur la page "Reprise après sinistre" de la console Google Cloud.

gcloud

Activez la PITR lors de la création de la base de données à l'aide de la commande gcloud firestore databases create, comme suit:

gcloud firestore databases create\
  --location=LOCATION\
  [--database=DATABASE_ID; default="(default)"]\
  [--type=TYPE; default="firestore-native"]\
  --enable-pitr

Remplacez les valeurs comme suit :

  • LOCATION : emplacement dans lequel vous souhaitez créer votre base de données.
  • DATABASE_ID : défini sur l'ID de la base de données ou (valeur par défaut).
  • TYPE : défini sur firestore-native.

Vous pouvez désactiver PITR à l'aide de la commande gcloud firestore databases update comme suit:

gcloud firestore databases update\
  [--database=DATABASE_ID; default="(default)"]\
  --no-enable-pitr

Remplacez les valeurs comme suit :

  • DATABASE_ID : défini sur l'ID de la base de données ou (valeur par défaut).

Obtenir la durée de conservation et la date de la première version

Console

  1. Dans la console Google Cloud, accédez à la page Base de données.

    Accéder à la page "Bases de données"

  2. Sélectionnez la base de données requise dans la liste des bases de données.

  3. Dans le menu de navigation, cliquez sur Reprise après sinistre.

  4. Dans la section Paramètres, notez la durée de conservation et la date de la première version.

    • Durée de conservation: période pendant laquelle Cloud Firestore conserve toutes les versions de données de la base de données. La valeur est d'une heure lorsque la récupération PITR est désactivée et de sept jours lorsqu'elle est activée.
    • Heure de la version la plus ancienne: horodatage le plus ancien à partir duquel les anciennes versions des données peuvent être lues dans la période de récupération PITR. Cette valeur est mise à jour en continu par Cloud Firestore et devient obsolète au moment où il est interrogé. Si vous utilisez cette valeur pour récupérer des données, veillez à tenir compte du moment où la valeur est interrogée jusqu'au moment où vous lancez la récupération.
    • Récupération à un moment précis: affiche Enabled si la récupération à un moment précis est activée. Si la récupération PITR est désactivée, l'option Disabled s'affiche.

gcloud

Exécutez la commande gcloud firestore databases describe comme suit:

gcloud firestore databases describe --database=DATABASE_ID

Remplacez DATABASE_ID par l'ID de la base de données ou par '(default)'.

Voici le résultat :

    appEngineIntegrationMode: ENABLED
    concurrencyMode: PESSIMISTIC
    createTime: '2021-03-24T17:02:35.234Z'
    deleteProtectionState: DELETE_PROTECTION_DISABLED
    earliestVersionTime: '2023-06-12T16:17:25.222474Z'
    etag: IIDayqOevv8CMNTvyNK4uv8C
    keyPrefix: s
    locationId: nam5
    name: projects/PROJECT_ID/databases/DATABASE_ID
    pointInTimeRecoveryEnablement: POINT_IN_TIME_RECOVERY_DISABLED
    type: FIRESTORE_NATIVE
    uid: 5230c382-dcd2-468f-8cb3-2a1acfde2b32
    updateTime: '2021-11-17T17:48:22.171180Z'
    versionRetentionPeriod: 3600s

où :

  • earliestVersionTime: code temporel des données PITR les plus anciennes stockées.
  • pointInTimeRecoveryEnablement: affiche POINT_IN_TIME_RECOVERY_ENABLED si la récupération PITR est activée. Si la PITR est désactivée, POINT_IN_TIME_RECOVERY_DISABLED s'affiche ou le champ pointInTimeRecoveryEnablement n'est pas affiché.
  • versionRetentionPeriod: période pendant laquelle les données PITR sont conservées, en millisecondes. La valeur peut être d'une heure lorsque la récupération PITR est désactivée ou de sept jours si elle est activée.

Lire les données PITR

Vous pouvez lire les données PITR à l'aide des bibliothèques clientes, des méthodes de l'API REST ou du connecteur Apache Beam FirestoreIO.

Bibliothèques clientes

Java

Vous devez utiliser la transaction ReadOnly pour lire les données PITR. Vous ne pouvez pas spécifier directement readTime dans les lectures. Pour en savoir plus, consultez la page Transactions et écritures par lot.

  Firestore firestore = …

  TransactionOptions options =
          TransactionOptions.createReadOnlyOptionsBuilder()
              .setReadTime(
                  com.google.protobuf.Timestamp.newBuilder()
                      .setSeconds(1684098540L)
                      .setNanos(0))
              .build();

  ApiFuture<Void> futureTransaction = firestore.runTransaction(
              transaction -> {
                // Does a snapshot read document lookup
                final DocumentSnapshot documentResult =
                    transaction.get(documentReference).get();

                // Executes a snapshot read query
                final QuerySnapshot queryResult =
                  transaction.get(query).get();
              },
              options);

  // Blocks on transaction to complete
  futureTransaction.get();

Nœud

Vous devez utiliser une transaction ReadOnly pour lire les données PITR. Vous ne pouvez pas spécifier directement readTime dans les lectures. Pour en savoir plus, consultez la page Transactions et écritures par lot.

  const documentSnapshot = await firestore.runTransaction(
    updateFunction => updateFunction.get(documentRef),
    {readOnly: true, readTime: new Firestore.Timestamp(1684098540, 0)}
);

  const querySnapshot = await firestore.runTransaction(
    updateFunction => updateFunction.get(query),
    {readOnly: true, readTime: new Firestore.Timestamp(1684098540, 0)}
  )

API REST

Les lectures PITR sont compatibles avec toutes les méthodes de lecture Cloud Firestore, à savoir get, list, batchGet, listCollectionIds, listDocuments, runQuery, runAggregationQuery et partitionQuery.

Pour effectuer une lecture à l'aide des méthodes REST, essayez l'une des options suivantes:

  1. Dans votre requête de méthode de lecture, transmettez la valeur readTime en tant que code temporel PITR compatible dans la méthode readOptions. Un code temporel PITR peut être un code temporel précis à la microseconde au cours de la dernière heure ou un code temporel entier à la minute au-delà de la dernière heure, mais pas avant l'earliestVersionTime.

  2. Utilisez le paramètre readTime avec la méthode BeginTransaction dans le cadre d'une transaction ReadOnly pour plusieurs lectures PITR.

Apache Beam

Utilisez le connecteur Apache Beam Cloud FirestoreIO pour lire ou écrire des documents dans une base de données Cloud Firestore à grande échelle avec Dataflow.

Les lectures PITR sont acceptées dans la méthode de lecture suivante du connecteur d'E/S Cloud Firestore. Ces méthodes de lecture sont compatibles avec la méthode withReadTime(@Nullable Instant readTime) que vous pouvez utiliser pour les lectures PITR:

Java

Le code suivant peut être utilisé avec l'exemple de code de pipeline Dataflow pour les opérations de lecture ou d'écriture groupées. L'exemple utilise la méthode withReadTime(@Nullable Instant readTime) pour les lectures PITR.

  Instant readTime = Instant.ofEpochSecond(1684098540L);

  PCollection<Document> documents =
      pipeline
          .apply(Create.of(collectionId))
          .apply(
              new FilterDocumentsQuery(
                  firestoreOptions.getProjectId(), firestoreOptions.getDatabaseId()))
          .apply(FirestoreIO.v1().read().runQuery().withReadTime(readTime).withRpcQosOptions(rpcQosOptions).build())
  ...

Pour obtenir la liste complète des exemples readTime dans le pipeline Dataflow, consultez le dépôt GitHub.

Exporter et importer des données PITR

Vous pouvez exporter votre base de données vers Cloud Storage à partir de données PITR à l'aide de la commande gcloud firestore export. Vous pouvez exporter des données PITR dont le code temporel correspond à une minute entière au cours des sept derniers jours, mais pas avant le earliestVersionTime. Si les données n'existent plus à l'horodatage spécifié, l'opération d'exportation échoue.

L'opération d'exportation PITR est compatible avec tous les filtres, y compris l'exportation de tous les documents et l'exportation de collections spécifiques.

  1. Exportez la base de données en spécifiant le paramètre snapshot-time vers l'horodatage de récupération souhaité.

    gcloud

    Exécutez la commande suivante pour exporter la base de données vers votre bucket.

    gcloud firestore export gs://BUCKET_NAME_PATH \
    --snapshot-time=PITR_TIMESTAMP \
    --collection-ids=COLLECTION_IDS \
    --namespace-ids=NAMESPACE_IDS

    Où :

    • BUCKET_NAME_PATH : bucket Cloud Storage valide avec un préfixe de chemin facultatif où les fichiers d'exportation sont stockés.
    • PITR_TIMESTAMP : code temporel PITR avec une précision de minute, par exemple 2023-05-26T10:20:00.00Z ou 2023-10-19T10:30:00.00-07:00.
    • COLLECTION_IDS : liste des ID de collection ou des ID de groupe de collection, par exemple 'specific-collection-group1','specific-collection-group2'.
    • NAMESPACE_IDS : liste d'ID d'espaces de noms, par exemple -'customer','orders'.

    Notez les points suivants avant d'exporter des données PITR:

    • Spécifiez l'horodatage au format RFC 3339. Par exemple, 2023-05-26T10:20:00.00Z ou 2023-10-19T10:30:00.00-07:00.
    • Assurez-vous que l'horodatage que vous spécifiez est un code temporel entier de la minute au cours des sept derniers jours, mais pas avant le earliestVersionTime. Si les données n'existent plus à l'horodatage spécifié, une erreur est générée. Le code temporel doit être une minute entière, même si l'heure spécifiée est dans l'heure précédente.
    • Les exportations PITR ayant échoué ne vous sont pas facturées.

  2. Importez-les dans une base de données.

    Suivez la procédure décrite dans Importer tous les documents pour importer votre base de données exportée. Si un document existe déjà dans votre base de données, il sera écrasé.