Utilizzare il recupero point-in-time (PITR)

Questa pagina descrive come utilizzare il recupero point-in-time (PITR) per conservare e recuperare i dati in Cloud Firestore.

Per comprendere i concetti del recupero point-in-time, consulta Recupero point-in-time.

Autorizzazioni

Per ottenere le autorizzazioni necessarie per gestire le impostazioni PITR, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto in cui vuoi attivare PITR:

• Proprietario di Cloud Datastore (roles/datastore.owner)

Per i ruoli personalizzati, assicurati che siano concesse le seguenti autorizzazioni:

• Per attivare PITR durante la creazione di un database: datastore.databases.create
• Per aggiornare le impostazioni PITR nel database esistente: datastore.databases.update,datastore.databases.list
• Per eseguire letture dai dati PITR: datastore.databases.get,datastore.entities.get,datastore.entities.list
• Per esportare i dati PITR: datastore.databases.export
• Per importare i dati PITR: datastore.databases.import

Prima di iniziare

Tieni presente quanto segue prima di iniziare a utilizzare la PITR:

• Non puoi iniziare a leggere da sette giorni prima del momento attuale subito dopo aver attivato la PITR.
• Se vuoi attivare la RPI quando crei un database, devi utilizzare il comando gcloud firestore databases create. L'attivazione del PITR durante la creazione di un database utilizzando la console Google Cloud non è supportata.
• Cloud Firestore inizia a conservare le versioni da quel momento in poi dopo aver attivato il PITR.
• Non puoi leggere i dati PITR nella finestra PITR dopo aver disattivato la funzionalità.
• Se riattivi PITR immediatamente dopo averlo disattivato, i dati PITR precedenti non sono più disponibili. Tutti i dati PITR creati prima della disattivazione del PITR verranno eliminati dopo la data di scadenza del PITR.
• Se hai eliminato accidentalmente dei dati nell'ultima ora e il PITR è disattivato, puoi recuperarli attivando il PITR entro un'ora dall'eliminazione.
• Qualsiasi lettura eseguita sui dati PITR scaduti non va a buon fine.

Attivare PITR

Prima di utilizzare la copia incrementale del piano di recupero, attiva la fatturazione per il tuo progetto Google Cloud. Solo i progetti Google Cloud con la fatturazione abilitata possono utilizzare la funzionalità PITR.

Per attivare il PITR per il tuo database:

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

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

Ottenere il periodo di conservazione e l'ora della versione più recente

gcloud firestore databases describe --database=DATABASE_ID

    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

Leggere i dati PITR

Puoi leggere i dati PITR utilizzando le librerie client, i metodi dell'API REST o il connettore Apache Beam FirestoreIO.

  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)}
  )

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

Esportazione e importazione dai dati PITR

Puoi esportare il database in Cloud Storage dai dati PITR utilizzando il comando gcloud firestore export. Puoi esportare i dati PITR in cui il timestamp è un timestamp intero di un minuto negli ultimi sette giorni, ma non prima del giorno earliestVersionTime. Se i dati non esistono più al timestamp specificato, l'operazione di esportazione non va a buon fine.

L'operazione di esportazione PITR supporta tutti i filtri, inclusa l'esportazione di tutti i documenti e di raccolte specifiche.

1. Esporta il database specificando il parametro snapshot-time con il timestamp di recupero desiderato.

   gcloud

   Esegui il comando seguente per esportare il database nel bucket.

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

   Dove,

   • BUCKET_NAME_PATH: un bucket Cloud Storage valido con un prefisso di percorso facoltativo in cui vengono archiviati i file di esportazione.
   • PITR_TIMESTAMP: un timestamp PITR con granularità a livello di minuto, ad esempio 2023-05-26T10:20:00.00Z o 2023-10-19T10:30:00.00-07:00.
   • COLLECTION_IDS: un elenco di ID raccolta o ID gruppo di raccolte, ad esempio 'specific-collection-group1','specific-collection-group2'.
   • NAMESPACE_IDS: un elenco di ID spazio dei nomi, ad esempio 'customer','orders'.

   Tieni presente quanto segue prima di esportare i dati PITR:

   • Specifica il timestamp nel formato RFC 3339. Ad esempio, 2023-05-26T10:20:00.00Z o 2023-10-19T10:30:00.00-07:00.
   • Assicurati che il timestamp specificato sia un timestamp di un minuto intero degli ultimi sette giorni, ma non precedente al giorno earliestVersionTime. Se i dati non esistono più al timestamp specificato, viene generato un errore. Il timestamp deve essere un minuto intero, anche se l'ora specificata è compresa nell'ora precedente.
   • Non ti viene addebitato alcun costo per un'esportazione PITR non riuscita.

2. Importazione in un database.

   Segui la procedura descritta in Importare tutti i documenti per importare il database esportato. Se nel database esiste già un documento, verrà sovrascritto.