Praca z odzyskiwaniem do określonego momentu (PITR)

Konsola

1. W konsoli Google Cloud otwórz stronę Bazy danych.

   Otwórz stronę Bazy danych

2. Na liście baz danych wybierz odpowiednią bazę danych.

3. W menu nawigacyjnym kliknij Odtwarzanie awaryjne.

4. Aby edytować ustawienia, kliknij Edytuj.

5. Zaznacz pole wyboru Włącz odzyskiwanie do określonego momentu i kliknij Zapisz.

Włączenie PITR wiąże się z kosztami przechowywania. Więcej informacji znajdziesz w cenniku.

Aby wyłączyć PITR, odznacz pole wyboru Włącz odzyskiwanie do określonego momentu na stronie Odtwarzanie awaryjne w konsoli Google Cloud.

gcloud

Włącz PITR podczas tworzenia bazy danych za pomocą gcloud firestore databases create i polecenia --enable-ptir w ten sposób:

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

Zastąp wartości w ten sposób:

• LOCATION – lokalizacja, w której chcesz utworzyć bazę danych.
• DATABASE_ID – identyfikator bazy danych.

PITR możesz wyłączyć za pomocą polecenia gcloud firestore databases update w ten sposób:

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

Zastąp wartości w ten sposób:

• DATABASE_ID – identyfikator bazy danych lub ` (default)`.

Konsola

1. W konsoli Google Cloud otwórz stronę Bazy danych.

   Otwórz stronę Bazy danych

2. Na liście baz danych wybierz odpowiednią bazę danych.

3. W menu nawigacyjnym kliknij Odtwarzanie awaryjne.

4. W sekcji Ustawienia zanotuj Okres przechowywania i Najwcześniejsza wersja.

   • Okres przechowywania: okres, w którym Cloud Firestore przechowuje wszystkie wersje danych bazy danych. Gdy PITR jest wyłączone, wartość wynosi 1 godzinę, a gdy jest włączone – 7 dni.
   • Najwcześniejsza wersja: najwcześniejsza sygnatura czasowa, w której można odczytać starsze wersje danych w oknie odzyskiwania do określonego momentu. Ta wartość jest stale aktualizowana przez Cloud Firestore i staje się nieaktualna w momencie wysłania zapytania. Jeśli używasz tej wartości do odzyskiwania danych, uwzględnij czas od momentu wysłania zapytania do momentu rozpoczęcia odzyskiwania.
   • Odzyskiwanie do określonego momentu: jeśli PITR jest włączone, wyświetla się wartość Enabled. Jeśli PITR jest wyłączone, zobaczysz Disabled.

gcloud

Uruchom polecenie gcloud firestore databases describe w ten sposób:

gcloud firestore databases describe --database=DATABASE_ID

Zastąp DATABASE_ID identyfikatorem bazy danych lub '(default)'.

Oto dane wyjściowe:

    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

gdzie:

• earliestVersionTime: sygnatura czasowa najwcześniejszych przechowywanych danych PITR.
• pointInTimeRecoveryEnablement: jeśli PITR jest włączone, wyświetla się wartość POINT_IN_TIME_RECOVERY_ENABLED. Jeśli PITR jest wyłączone, zobaczysz POINT_IN_TIME_RECOVERY_DISABLED lub pole pointInTimeRecoveryEnablement może się nie wyświetlać.
• versionRetentionPeriod: okres, przez który dane PITR są przechowywane w milisekundach. Wartość może wynosić 1 godzinę, gdy PITR jest wyłączone, lub 7 dni, gdy PITR jest włączone.

Biblioteki klienta

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

Interfejs API typu REST

Odczyty PITR są obsługiwane we wszystkich Cloud Firestore metodach odczytu, czyli get, list, batchGet, listCollectionIds, listDocuments, runQuery, runAggregationQuery i partitionQuery.

Aby wykonać odczyt za pomocą metod REST, wypróbuj jedną z tych opcji:

1. W żądaniu metody odczytu przekaż wartość readTime jako obsługiwaną sygnaturę czasową odzyskiwania do określonego momentu w metodzie readOptions. Sygnatura czasowa PITR może być sygnaturą czasową z dokładnością do mikrosekund w ciągu ostatniej godziny lub sygnaturą czasową z dokładnością do minuty poza ostatnią godziną, ale nie wcześniejszą niż earliestVersionTime.

2. Użyj parametru readTime razem z metodą BeginTransaction w ramach transakcji ReadOnly w przypadku wielu odczytów PITR.

Apache Beam

Użyj oprogramowania sprzęgającego Cloud FirestoreIO Apache Beam, aby odczytywać lub zapisywać dokumenty w bazie danych Cloud Firestore na dużą skalę za pomocą Dataflow.

Odczyty PITR są obsługiwane w tej metodzie odczytu oprogramowania sprzęgającego Cloud FirestoreIO. Te metody odczytu obsługują metodę withReadTime(@Nullable Instant readTime), której możesz używać do odczytów PITR:

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

Pełną listę przykładów readTime w potoku Dataflow znajdziesz w repozytorium GitHub.

Konsola

Firebase konsola nie obsługuje klonowania baz danych. Do klonowania baz danych możesz użyć instrukcji dotyczących Google Cloud CLI.

gcloud

Aby sklonować bazę danych, użyj polecenia gcloud firestore databases clone:

gcloud firestore databases clone \
--source-database='SOURCE_DATABASE' \
--snapshot-time='PITR_TIMESTAMP' \
--destination-database='DESTINATION_DATABASE_ID'

Zastąp następujące elementy:

• SOURCE_DATABASE: nazwa istniejącej bazy danych, którą chcesz sklonować. Nazwa ma format projects/PROJECT_ID/databases/SOURCE_DATABASE_ID.

• PITR_TIMESTAMP: sygnatura czasowa PITR w formacie RFC 3339, z dokładnością do minuty. Na przykład: 2025-06-01T10:20:00.00Z lub 2025-06-01T10:30:00.00-07:00.

• DESTINATION_DATABASE_ID: identyfikator bazy danych dla nowej sklonowanej bazy danych. Ten identyfikator bazy danych nie może być powiązany z istniejącą bazą danych.

Przykład:

gcloud firestore databases clone \
--source-database='projects/example-project/databases/(default)' \
--snapshot-time='2025-06-01T10:20:00.00Z' \
--destination-database='example-dest-db'

Jeśli podczas klonowania bazy danych chcesz powiązać ją z tagami, użyj poprzedniego polecenia z flagą --tags, która jest opcjonalną listą tagów w postaci par KLUCZ=WARTOŚĆ.

Przykład:

gcloud firestore databases clone \
--source-database='projects/example-project/databases/(default)' \
--snapshot-time='2025-06-01T10:20:00.00Z' \
--destination-database='example-dest-db' \
--tags=key1=value1,key2=value2

Domyślnie sklonowana baza danych będzie miała taką samą konfigurację szyfrowania jak źródłowa baza danych. Aby zmienić konfigurację szyfrowania, użyj argumentu --encryption-type:

• (Domyślnie) use-source-encryption: użyj tej samej konfiguracji szyfrowania co źródłowa baza danych.
• google-default-encryption: użyj domyślnego szyfrowania Google.
• customer-managed-encryption: użyj szyfrowania CMEK. Określ identyfikator klucza w argumencie --kms-key-name.

Ten przykład pokazuje, jak skonfigurować szyfrowanie CMEK dla sklonowanej bazy danych:

gcloud firestore databases clone \
--source-database='projects/example-project/databases/(default)' \
--snapshot-time='2025-06-01T10:20:00.00Z' \
--destination-database='example-dest-db' \
--encryption-type='customer-managed-encryption' \
--kms-key-name='projects/example-project/locations/us-central1/keyRings/example-key-ring/cryptoKeys/example-key'

wiersz poleceń Firebase

Aby sklonować bazę danych, użyj polecenia firebase firestore:databases:clone:

firebase firestore:databases:clone \
'SOURCE_DATABASE' \
'DESTINATION_DATABASE' \
--snapshot-time 'PITR_TIMESTAMP'

Zastąp następujące elementy:

• SOURCE_DATABASE: nazwa istniejącej bazy danych, którą chcesz sklonować. Nazwa ma format projects/PROJECT_ID/databases/SOURCE_DATABASE_ID.

• DESTINATION_DATABASE: nazwa bazy danych dla nowej sklonowanej bazy danych. Nazwa ma format projects/PROJECT_ID/databases/DESTINATION_DATABASE_ID. Ta nazwa bazy danych nie może być powiązana z istniejącą bazą danych.

• PITR_TIMESTAMP: sygnatura czasowa PITR w formacie RFC 3339, z dokładnością do minuty. Na przykład: 2025-06-01T10:20:00.00Z lub 2025-06-01T10:30:00.00-07:00. Jeśli nie określisz sygnatury czasowej, wybrany snapshot będzie odpowiadał bieżącej godzinie zaokrąglonej w dół do minuty.

Domyślnie sklonowana baza danych będzie miała taką samą konfigurację szyfrowania jak źródłowa baza danych. Aby zmienić konfigurację szyfrowania, użyj argumentu --encryption-type:

• (Domyślnie) USE_SOURCE_ENCRYPTION: użyj tej samej konfiguracji szyfrowania co źródłowa baza danych.
• GOOGLE_DEFAULT_ENCRYPTION: użyj domyślnego szyfrowania Google.
• CUSTOMER_MANAGED_ENCRYPTION: użyj szyfrowania CMEK. Określ identyfikator klucza w argumencie --kms-key-name.

Ten przykład pokazuje, jak skonfigurować szyfrowanie CMEK dla sklonowanej bazy danych:

firebase firestore:databases:clone \
'projects/example-project/databases/(default)' \
'projects/example-project/databases/example-dest-db' \
--snapshot-time 'PITR_TIMESTAMP' \
--encryption-type CUSTOMER_MANAGED_ENCRYPTION