Работа с восстановлением на момент времени (PITR)

На этой странице описывается, как использовать восстановление на определенный момент времени (PITR) для сохранения и восстановления данных в Cloud Firestore .

Чтобы понять концепции PITR, см . раздел Восстановление на определенный момент времени .

Разрешения

Чтобы получить разрешения, необходимые для управления настройками PITR, попросите администратора предоставить вам следующие роли IAM в проекте, в котором вы хотите включить PITR:

• Владелец облачного хранилища данных ( roles/datastore.owner )

Для пользовательских ролей убедитесь, что предоставлены следующие разрешения:

• Чтобы включить PITR при создании базы данных: datastore.databases.create
• Чтобы обновить настройки PITR в существующей базе данных: datastore.databases.update , datastore.databases.list
• Для чтения данных PITR: datastore.databases.get , datastore.entities.get , datastore.entities.list
• Для экспорта данных PITR: datastore.databases.export
• Для импорта данных PITR: datastore.databases.import

Прежде чем начать

Прежде чем начать использовать PITR, обратите внимание на следующие моменты:

• Вы не сможете начать чтение данных за последние семь дней сразу после включения PITR.
• Если вы хотите включить PITR при создании базы данных, необходимо использовать команду gcloud firestore databases create . Включение PITR при создании базы данных с помощью консоли Google Cloud не поддерживается.
• Cloud Firestore начинает сохранять версии с момента включения PITR.
• После отключения PITR вы не сможете прочитать данные PITR в окне PITR.
• Если вы снова включите PITR сразу после его отключения, предыдущие данные PITR станут недоступны. Все данные PITR, созданные до отключения PITR, будут удалены по истечении срока действия PITR.
• Если вы случайно удалили данные в течение последнего часа и PITR отключен, вы можете восстановить свои данные, включив PITR в течение одного часа после удаления.
• Любое чтение устаревших данных PITR завершается неудачей.

Включить PITR

Перед использованием PITR включите биллинг для вашего проекта Google Cloud . Функциональность PITR доступна только для проектов Google Cloud с включённым биллингом.

Чтобы включить PITR для вашей базы данных:

gcloud firestore databases create\
  --location=LOCATION\
  --database=DATABASE_ID\
  --type=firestore-native\
  --enable-pitr

gcloud firestore databases update\
  --database=DATABASE_ID\
  --no-enable-pitr

Получите период хранения и время самой ранней версии

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

Чтение данных 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)}
);

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

Экспорт и импорт из данных PITR

Вы можете экспортировать базу данных PITR в Cloud Storage с помощью команды gcloud firestore export . Вы можете экспортировать данные PITR с меткой времени в течение целых минут в течение последних семи дней, но не ранее самой ранней версии (the earliestVersionTime . Если данные по указанной метке времени отсутствуют, операция экспорта завершается ошибкой.

Операция экспорта PITR поддерживает все фильтры, включая экспорт всех документов и экспорт определенных коллекций.

1. Экспортируйте базу данных, указав параметр snapshot-time для выбранной временной метки восстановления.

   gcloud

   Выполните следующую команду, чтобы экспортировать базу данных в ваш контейнер.

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

   Где,

   • BUCKET_NAME_PATH — допустимый контейнер Cloud Storage с необязательным префиксом пути, где хранятся экспортированные файлы.
   • PITR_TIMESTAMP — временная метка PITR с точностью до минуты, например, 2023-05-26T10:20:00.00Z или 2023-10-19T10:30:00.00-07:00 .
   • COLLECTION_IDS — список идентификаторов коллекций или идентификаторов групп коллекций, например 'specific-collection-group1','specific-collection-group2' .
   • NAMESPACE_IDS — список идентификаторов пространств имен, например 'customer','orders' .

   Перед экспортом данных PITR обратите внимание на следующие моменты:

   • Укажите временную метку в формате RFC 3339. Например, 2023-05-26T10:20:00.00Z или 2023-10-19T10:30:00.00-07:00 .
   • Убедитесь, что указанная вами временная метка представляет собой целую минуту в пределах последних семи дней, но не ранее, чем earliestVersionTime . Если данные по указанной временной метке отсутствуют, генерируется ошибка. Временная метка должна представлять собой целую минуту, даже если указанное время находится в пределах последнего часа.
   • Плата за неудачный экспорт PITR не взимается.

2. Импорт в базу данных.

   Чтобы импортировать экспортированную базу данных, выполните действия, описанные в разделе «Импорт всех документов» . Если в базе данных уже есть какой-либо документ, он будет перезаписан.