使用時間點復原 (PITR)

控制台

1. 前往 Google Cloud 控制台的「Databases」頁面。

   前往「資料庫」

2. 從資料庫清單中選取必要資料庫。

3. 在導覽選單中，按一下「Disaster Recovery」(災難復原)。

4. 按一下「編輯」即可編輯設定。

5. 勾選「啟用指定時間點復原」核取方塊，然後按一下「儲存」。

啟用時間點復原功能會產生儲存費用。詳情請參閱定價。

如要停用 PITR，請在 Google Cloud 控制台的「災難復原」頁面中，取消勾選「啟用時間點復原」核取方塊。

gcloud

在建立資料庫時啟用 PITR，方法是使用 gcloud firestore databases create 指令，如下所示：

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

請按照下列方式替換值：

• LOCATION：您要建立資料庫的位置。
• DATABASE_ID：設為資料庫 ID 或 (預設)。
• TYPE - 設為 firestore-native。

您可以使用 gcloud firestore databases update 指令停用 PITR，如下所示：

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

請按照下列方式替換值：

• DATABASE_ID：設為資料庫 ID 或 (預設)。

控制台

1. 前往 Google Cloud 控制台的「Databases」頁面。

   前往「資料庫」

2. 從資料庫清單中選取必要資料庫。

3. 在導覽選單中，按一下「Disaster Recovery」(災難復原)。

4. 在「設定」部分，請注意「保留期間」和「最早版本時間」。

   • 保留期限：Cloud Firestore 保留資料庫所有版本資料的期限。這個值在停用 PITR 時為一小時，啟用 PITR 時則為七天。
   • 最早版本時間：在 PITR 期間可讀取舊版資料的最早時間戳記。這個值會持續由 Cloud Firestore 更新，並在查詢時變為舊值。如果您要使用這個值來復原資料，請務必考量從查詢該值到啟動復原程序之間的時間。
   • 時間點復原：如果已啟用 PITR，則會顯示 Enabled。如果 PITR 已停用，您會看到 Disabled。

gcloud

執行 gcloud firestore databases describe 指令，如下所示：

gcloud firestore databases describe --database=DATABASE_ID

將 DATABASE_ID 替換為資料庫 ID 或 '(default)'。

輸出內容如下：

    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

其中：

• earliestVersionTime：儲存的 PITR 最早資料時間戳記。
• pointInTimeRecoveryEnablement：如果已啟用 PITR，則會顯示 POINT_IN_TIME_RECOVERY_ENABLED。如果停用 PITR，您會看到 POINT_IN_TIME_RECOVERY_DISABLED，或是可能不會顯示 pointInTimeRecoveryEnablement 欄位。
• versionRetentionPeriod：時間點復原功能保留資料的時間長度 (以毫秒為單位)。值可以是 1 小時 (如果停用 PITR)，或 7 天 (如果啟用 PITR)。

用戶端程式庫

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

REST API

所有 Cloud Firestore 讀取方法都支援 PITR 讀取作業，包括 get、list、batchGet、listCollectionIds、listDocuments、runQuery、runAggregationQuery 和 partitionQuery。

如要使用 REST 方法執行讀取作業，請嘗試下列其中一種做法：

1. 在讀取方法要求中，將 readTime 值傳遞為 readOptions 方法中支援的 PITR 時間戳記。PITR 時間戳記可以是過去一小時內的微秒精確度時間戳記，或是過去一小時後的整分鐘時間戳記，但不得早於 earliestVersionTime。

2. 將 readTime 參數與 BeginTransaction 方法搭配使用，做為多個 PITR 讀取作業的 ReadOnly 交易的一部分。

Apache Beam

使用 Cloud FirestoreIO Apache Beam 連接器，透過 Dataflow 大規模讀取或寫入 Cloud Firestore 資料庫中的文件。

Cloud FirestoreIO 連接器的下列讀取方法支援 PITR 讀取作業。以下讀取方法支援您用於 PITR 讀取的 withReadTime(@Nullable Instant readTime) 方法：

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

如需 Dataflow 管道中 readTime 範例的完整清單，請參閱 GitHub 存放區。