PITR(point-in-time recovery) 작업

이 페이지에서는 PITR(point-in-time recovery)을 사용하여 Cloud Firestore에서 데이터를 보관하고 복구하는 방법을 설명합니다.

PITR 개념을 이해하려면 PITR(point-in-time recovery)을 참조하세요.

권한

PITR 설정을 관리하는 데 필요한 권한을 얻으려면 관리자에게 PITR을 사용 설정할 프로젝트에 대한 다음 IAM 역할을 부여해 달라고 요청하세요.

• Cloud Datastore 소유자(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을 사용 설정한 직후에는 7일 전 데이터를 읽을 수 없습니다.
• 데이터베이스를 만들 때 PITR을 사용 설정하려면 gcloud firestore databases create 명령어를 사용해야 합니다. 데이터베이스를 만드는 동안 Google Cloud 콘솔을 사용하여 PITR을 사용 설정할 수 없습니다.
• Cloud Firestore는 PITR을 사용 설정한 후부터 버전을 유지합니다.
• PITR을 사용 중지한 후에는 PITR 기간의 PITR 데이터를 읽을 수 없습니다.
• PITR을 중지한 직후에 다시 사용 설정하면 이전 PITR 데이터를 더 이상 사용할 수 없습니다. PITR을 사용 중지하기 전에 생성된 모든 PITR 데이터는 PITR 만료일 이후에 삭제됩니다.
• 실수로 지난 1시간 동안의 데이터를 삭제하고 PITR이 사용 중지된 경우, 삭제 후 1시간 이내에 PITR을 사용 설정하여 데이터를 복원할 수 있습니다.
• 만료된 PITR 데이터에 대해 수행된 모든 읽기는 실패합니다.

PITR 사용 설정

PITR을 사용하기 전에 Google Cloud 프로젝트에 결제를 사용 설정합니다. 결제가 사용 설정된 Google Cloud 프로젝트에서만 PITR 기능을 사용할 수 있습니다.

데이터베이스에 PITR을 사용 설정하려면 다음 안내를 따르세요.

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

보관 기간 및 가장 초기 버전 시간 가져오기

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 데이터 읽기

클라이언트 라이브러리, REST API 메서드 또는 FirestoreIO Apache Beam 커넥터를 사용하여 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 데이터에서 내보내기 및 가져오기

gcloud firestore export 명령어를 사용하여 PITR 데이터에서 Cloud Storage로 데이터베이스를 내보낼 수 있습니다. 타임스탬프가 지난 7일 이내의 1분 타임스탬프이고 earliestVersionTime 이후인 PITR 데이터를 내보낼 수 있습니다. 데이터가 더 이상 지정된 타임스탬프에 없으면 내보내기 작업이 실패합니다.

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 - 컬렉션 ID 또는 컬렉션 그룹 ID의 목록입니다(예: 'specific-collection-group1','specific-collection-group2').
   • NAMESPACE_IDS - 네임스페이스 ID 목록입니다(예: 'customer','orders').

   PITR 데이터를 내보내기 전에 다음 사항에 유의하세요.

   • RFC 3339 형식으로 타임스탬프를 지정합니다. 예를 들면 2023-05-26T10:20:00.00Z 또는 2023-10-19T10:30:00.00-07:00입니다.
   • 지정한 타임스탬프가 지난 7일 이내의 1분 타임스탬프여야 하지만 earliestVersionTime 이전이어야 합니다. 지정된 타임스탬프에 데이터가 더 이상 존재하지 않으면 오류가 발생합니다. 타임스탬프는 지정된 시간이 지난 1시간 이내인 경우에도 1분이어야 합니다.
   • 실패한 PITR 내보내기에 대해서는 요금이 청구되지 않습니다.

2. 데이터베이스로 가져옵니다.

   모든 문서 가져오기의 단계에 따라 내보낸 데이터베이스를 가져옵니다. 데이터베이스에 이미 문서가 있으면 덮어쓰게 됩니다.