Praca z odzyskiwaniem do określonego momentu (PITR)

Na tej stronie opisujemy, jak używać odzyskiwania do określonego momentu (PITR) do przechowywania i odzyskiwania danych w Cloud Firestore.

Aby poznać koncepcje PITR, przeczytaj artykuł Odzyskiwanie do określonego momentu.

Uprawnienia

Aby uzyskać uprawnienia potrzebne do zarządzania ustawieniami PITR, poproś administratora o przypisanie Ci tych ról uprawnień w projekcie, w którym chcesz włączyć PITR:

• Właściciel Cloud Datastore (roles/datastore.owner)

W przypadku ról niestandardowych sprawdź, czy przyznano te uprawnienia:

• Aby włączyć odzyskiwanie do określonego momentu podczas tworzenia bazy danych: datastore.databases.create
• Aby zaktualizować ustawienia odzyskiwania do określonego momentu w przypadku istniejącej bazy danych: datastore.databases.update,datastore.databases.list
• Aby odczytywać dane PITR: datastore.databases.get,datastore.entities.get,datastore.entities.list
• Aby wyeksportować dane PITR: datastore.databases.export
• Aby zaimportować dane PITR: datastore.databases.import

Zanim zaczniesz

Zanim zaczniesz korzystać z PITR, weź pod uwagę te kwestie:

• Po włączeniu PITR nie możesz od razu zacząć odczytywać danych sprzed 7 dni.
• Jeśli chcesz włączyć PITR podczas tworzenia bazy danych, musisz użyć polecenia gcloud firestore databases create. Włączanie PITR podczas tworzenia bazy danych za pomocą konsoli Google Cloud nie jest obsługiwane.
• Cloud Firestore zaczyna przechowywać wersje od momentu włączenia odzyskiwania do określonego momentu.
• Po wyłączeniu odzyskiwania do określonego momentu nie możesz odczytywać danych PITR w oknie PITR.
• Jeśli ponownie włączysz odzyskiwanie do określonego momentu zaraz po jego wyłączeniu, wcześniejsze dane używane do odzyskiwania do określonego momentu nie będą już dostępne. Wszystkie dane PITR utworzone przed wyłączeniem tej funkcji zostaną usunięte po upływie daty ważności PITR.
• Jeśli przypadkowo usuniesz dane w ciągu ostatniej godziny, a odzyskiwanie do określonego momentu jest wyłączone, możesz przywrócić dane, włączając odzyskiwanie do określonego momentu w ciągu godziny od usunięcia.
• Każdy odczyt wykonany na wygasłych danych PITR zakończy się niepowodzeniem.

Włączanie odzyskiwania do określonego momentu

Zanim zaczniesz korzystać z PITR, włącz płatności za projekt Google Cloud. Z funkcji PITR mogą korzystać tylko projekty Google Cloud z włączonymi płatnościami.

Aby włączyć odzyskiwanie do określonego momentu w bazie danych:

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

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

Pobieranie okresu przechowywania i czasu najwcześniejszej wersji

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

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

Eksportowanie i importowanie danych PITR

Możesz wyeksportować bazę danych do Cloud Storage z danych PITR za pomocą polecenia gcloud firestore export. Możesz eksportować dane PITR, których sygnatura czasowa jest pełną minutą w ciągu ostatnich 7 dni, ale nie wcześniej niż earliestVersionTime. Jeśli w określonym momencie dane już nie istnieją, eksportowanie się nie powiedzie.

Operacja eksportu PITR obsługuje wszystkie filtry, w tym eksport wszystkich dokumentów i eksport konkretnych kolekcji.

1. Wyeksportuj bazę danych, podając parametr snapshot-time dla wybranej sygnatury czasowej przywracania.

   gcloud

   Aby wyeksportować bazę danych do zasobnika, uruchom to polecenie.

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

   Gdzie,

   • BUCKET_NAME_PATH – prawidłowy Cloud Storage zasobnik z opcjonalnym prefiksem ścieżki, w którym są przechowywane pliki eksportu.
   • PITR_TIMESTAMP – sygnatura czasowa odzyskiwania do określonego momentu z dokładnością do minuty, np. 2023-05-26T10:20:00.00Z lub 2023-10-19T10:30:00.00-07:00.
   • COLLECTION_IDS – lista identyfikatorów kolekcji lub identyfikatorów grup kolekcji, np. 'specific-collection-group1','specific-collection-group2'.
   • NAMESPACE_IDS – lista identyfikatorów przestrzeni nazw, np. 'customer','orders'.

   Przed wyeksportowaniem danych PITR weź pod uwagę te kwestie:

   • Określ sygnaturę czasową w formacie RFC 3339. Na przykład 2023-05-26T10:20:00.00Z lub 2023-10-19T10:30:00.00-07:00.
   • Upewnij się, że podany znacznik czasu jest pełną minutą w ciągu ostatnich 7 dni, ale nie wcześniej niż earliestVersionTime. Jeśli w określonej sygnaturze czasowej nie ma już danych, zostanie wygenerowany błąd. Sygnatura czasowa musi być pełną minutą, nawet jeśli podany czas przypada w ciągu ostatniej godziny.
   • Nie obciążymy Cię płatnością za nieudany eksport PITR.

2. importować do bazy danych,

   Aby zaimportować wyeksportowaną bazę danych, wykonaj czynności opisane w sekcji Importowanie wszystkich dokumentów. Jeśli w bazie danych istnieje już jakiś dokument, zostanie on zastąpiony.