Trabaja con la recuperación de un momento determinado (PITR)

Consola

1. En la consola de Google Cloud Platform, ve a la página Bases de datos.

   Ir a Bases de datos

2. Selecciona la base de datos requerida de la lista.

3. En el menú de navegación, haga clic en Recuperación ante desastres.

4. Haz clic en Editar para editar la configuración.

5. Selecciona la casilla de verificación Habilitar la recuperación de un momento determinado y, luego, haz clic en Guardar.

Habilitar la PITR genera costos de almacenamiento. Consulta Precios para obtener más información.

Para inhabilitar la PITR, desmarca la casilla de verificación Habilitar la recuperación de un momento determinado de la página Recuperación ante desastres en la consola de GCP.

gcloud

Habilita la PITR durante la creación de la base de datos con el comando gcloud firestore databases create de la siguiente manera:

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

Reemplaza los valores de la siguiente manera:

• Location: La ubicación en la que quieres crear tu base de datos.
• DATABASE_ID: Se establece en el ID de la base de datos o en “(predeterminado)”.
• TYPE: Se establece en firestore-native.

Puedes inhabilitar la PITR con el comando gcloud firestore databases update de la siguiente manera:

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

Reemplaza los valores de la siguiente manera:

• DATABASE_ID: Se establece en el ID de la base de datos o en “(predeterminado)”.

Consola

1. En la consola de Google Cloud Platform, ve a la página Bases de datos.

   Ir a Bases de datos

2. Selecciona la base de datos requerida de la lista.

3. En el menú de navegación, haga clic en Recuperación ante desastres.

4. En la sección Configuración, observa el Período de retención y la Fecha de la versión más antigua.

   • Período de retención: Es el período en el que Cloud Firestore retiene todas las versiones de los datos de la base de datos. El valor es una hora cuando la PITR está inhabilitada y siete días cuando está habilitada.
   • Fecha de la versión más antigua: Es la primera marca de tiempo en la que se pueden leer las versiones anteriores de los datos en la ventana de PITR. Cloud Firestore actualiza este valor de forma continua y se vuelve inactivo en el momento en que se consulta. Si usas este valor para recuperar datos, asegúrate de tener en cuenta el tiempo desde el momento en que se consulta el valor hasta el momento en que inicias la recuperación.
   • Recuperación de un momento determinado: Muestra Enabled si la PITR está habilitada. Si la PITR está inhabilitada, verás Disabled.

gcloud

Ejecuta el comando gcloud firestore databases describe de la siguiente manera:

gcloud firestore databases describe --database=DATABASE_ID

Reemplaza DATABASE_ID por el ID de la base de datos o default.

Esta es la salida:

    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

En este ejemplo:

• earliestVersionTime: Es la marca de tiempo de los primeros datos de PITR almacenados.
• pointInTimeRecoveryEnablement: Muestra POINT_IN_TIME_RECOVERY_ENABLED si la PITR está habilitada. Si la PITR está inhabilitada, verás POINT_IN_TIME_RECOVERY_DISABLED o es posible que no se muestre el campo pointInTimeRecoveryEnablement.
• versionRetentionPeriod: Período en milisegundos para el que se retienen los datos de la PITR. El valor puede ser de una hora cuando la PITR está inhabilitada o de siete días si la PITR está habilitada.

Bibliotecas cliente

  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 de REST

Las lecturas de la PITR son compatibles con todos los métodos de lectura de Cloud Firestore, que son get, list, batchGet, listCollectionIds, listDocuments, runQuery, runAggregationQuery y partitionQuery.

Para realizar una lectura con los métodos de REST, prueba una de las siguientes opciones:

1. En la solicitud del método de lectura, pasa el valor readTime como una marca de tiempo de la PITR compatible en el método readOptions. Una marca de tiempo de la PITR puede ser una marca de tiempo de precisión de microsegundos dentro de la última hora o una marca de tiempo de un minuto entero más allá de la última hora, pero no antes de la earliestVersionTime.

2. Usa el parámetro readTime junto con el método BeginTransaction como parte de una transacción ReadOnly para varias lecturas de PITR.

Apache Beam

Usa el conector Cloud FirestoreIO de Apache Beam para leer o escribir documentos en una base de datos de Cloud Firestore a gran escala con Dataflow.

Las lecturas de la PITR son compatibles con el siguiente método de lectura del conector de Cloud FirestoreIO. Estos métodos de lectura admiten el método withReadTime(@Nullable Instant readTime) que puedes usar para las lecturas de la 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())
  ...

Para obtener una lista completa de los ejemplos de readTime en la canalización de Dataflow, consulta el repositorio de GitHub.