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

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 point dans le temps, décochez la case Activer la récupération point dans le temps 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).

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 les valeurs Durée de conservation et Date et heure de la version la plus ancienne.

   • 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.
   • Date et heure de la version la plus ancienne: horodatage le plus ancien à partir duquel les anciennes versions des données peuvent être lues dans la fenêtre 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 PITR 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/(default)
    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 premières données PITR 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 à un moment précis est désactivée ou de sept jours si elle est activée.

Bibliothèques clientes

  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();

  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 horodatage de précision de la microseconde au cours de la dernière heure ou d'une minute entière au-delà de l'heure précédente, mais pas antérieurs à 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 FirestoreE/S 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 :

• FirestoreV1.BatchGetDocuments
• FirestoreV1.ListCollectionIds
• FirestoreV1.ListDocuments
• FirestoreV1.PartitionQuery

• FirestoreV1.RunQuery

  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.