עבודה עם שחזור בנקודת זמן (PITR)

המסוף

1. נכנסים לדף Databases במסוף Google Cloud.

   כניסה לדף Databases

2. בוחרים את מסד הנתונים הרצוי מרשימת מסדי הנתונים.

3. בתפריט הניווט, לוחצים על תוכנית התאוששות מאסון (DR).

4. לוחצים על עריכה כדי לערוך את ההגדרות.

5. מסמנים את התיבה Enable point-in-time recovery ולוחצים על Save.

הפעלת PITR כרוכה בעלויות אחסון. מידע נוסף זמין במאמר תמחור.

כדי להשבית את ה-PITR, מבטלים את הסימון בתיבה Enable point-in-time recovery בדף תוכנית התאוששות מאסון (DR) במסוף Google Cloud.

gcloud

מפעילים את PITR במהלך יצירת מסד הנתונים באמצעות הפקודה gcloud firestore databases create והפקודה --enable-ptir, באופן הבא:

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

מחליפים את הערכים באופן הבא:

• ‫LOCATION – המיקום שבו רוצים ליצור את מסד הנתונים.
• ‫DATABASE_ID – מוגדר למזהה מסד נתונים.

כדי להשבית את ה-PITR, משתמשים בפקודה gcloud firestore databases update באופן הבא:

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

מחליפים את הערכים באופן הבא:

• ‫DATABASE_ID – מזהה מסד הנתונים או (default).

המסוף

1. נכנסים לדף Databases במסוף Google Cloud.

   כניסה לדף Databases

2. בוחרים את מסד הנתונים הרצוי מרשימת מסדי הנתונים.

3. בתפריט הניווט, לוחצים על תוכנית התאוששות מאסון (DR).

4. בקטע הגדרות, שימו לב לתקופת השמירה ולזמן הגרסה המוקדמת ביותר.

   • תקופת השמירה: התקופה שבה Cloud Firestore שומר את כל גרסאות הנתונים של מסד הנתונים. הערך הוא שעה אחת כש-PITR מושבת, ושבעה ימים כש-PITR מופעל.
   • זמן הגרסה המוקדמת ביותר: חותמת הזמן המוקדמת ביותר שבה אפשר לקרוא גרסאות ישנות יותר של הנתונים בחלון ה-PITR. הערך הזה מתעדכן כל הזמן על ידי Cloud Firestore והופך ללא עדכני ברגע ששולחים שאילתה לגביו. אם אתם משתמשים בערך הזה כדי לשחזר נתונים, חשוב להביא בחשבון את הזמן שעובר מהרגע שבו נשלחת השאילתה על הערך ועד לרגע שבו אתם מתחילים את השחזור.
   • שחזור מערכת מנקודה מסוימת בזמן (PITR): אם PITR מופעל, מוצג הערך Enabled. אם PITR מושבת, יופיע הערך Disabled.

gcloud

מריצים את הפקודה gcloud firestore databases describe באופן הבא:

gcloud firestore databases describe --database=DATABASE_ID

מחליפים את DATABASE_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: מוצג הערך POINT_IN_TIME_RECOVERY_ENABLED אם PITR מופעל. אם PITR מושבת, יוצג הערך POINT_IN_TIME_RECOVERY_DISABLED או שהשדה pointInTimeRecoveryEnablement לא יוצג.
• ‫versionRetentionPeriod: משך הזמן שבו נתוני ה-PITR נשמרים, באלפיות השנייה. הערך יכול להיות שעה אחת כש-PITR מושבת, או שבעה ימים כש-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)}
);

‫API בארכיטקטורת REST

קריאות PITR נתמכות בכל שיטות הקריאה של Cloud Firestore, שהן get,‏ list,‏ batchGet,‏ listCollectionIds,‏ listDocuments,‏ runQuery,‏ runAggregationQuery ו-partitionQuery.

כדי לבצע קריאה באמצעות שיטות REST, נסו אחת מהאפשרויות הבאות:

1. בבקשה של ה-method לקריאה, מעבירים את הערך של readTime כחותמת זמן נתמכת של PITR ב-method‏ readOptions. חותמת הזמן של ה-PITR יכולה להיות חותמת זמן מדויקת במיקרו-שניות בשעה האחרונה, או חותמת זמן של דקה שלמה לפני השעה האחרונה, אבל לא לפני earliestVersionTime.

2. משתמשים בפרמטר readTime יחד עם השיטה BeginTransaction כחלק מטרנזקציית ReadOnly לכמה קריאות של PITR.

Apache Beam

אפשר להשתמש במחבר Cloud FirestoreIO Apache Beam כדי לקרוא או לכתוב מסמכים במסד נתונים של Cloud Firestore בקנה מידה גדול באמצעות Dataflow.

אפשר לקרוא נתונים באמצעות PITR בשיטת הקריאה הבאה של מחבר ה-Cloud FirestoreIO. ה-methods האלה לקריאה תומכות ב-method‏ withReadTime(@Nullable Instant readTime), שבה אפשר להשתמש לקריאות 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())
  ...

לרשימה המלאה של דוגמאות ל-readTime בצינור עיבוד הנתונים של Dataflow, עיינו במאגר GitHub.

המסוף

מסוף Firebase לא תומך בשכפול מסדי נתונים. אתם יכולים להשתמש בהוראות של Google Cloud CLI כדי לשכפל מסדי נתונים.

gcloud

משתמשים בפקודה gcloud firestore databases clone כדי לשכפל מסד נתונים:

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

מחליפים את מה שכתוב בשדות הבאים:

• ‫SOURCE_DATABASE: שם מסד הנתונים הקיים שרוצים לשכפל. השם משתמש בפורמט projects/PROJECT_ID/databases/SOURCE_DATABASE_ID.

• ‫PITR_TIMESTAMP: חותמת זמן של PITR בפורמט RFC 3339, ברמת פירוט של דקות. לדוגמה: 2025-06-01T10:20:00.00Z או 2025-06-01T10:30:00.00-07:00.

• ‫DESTINATION_DATABASE_ID: מזהה מסד נתונים למסד נתונים משוכפל חדש. מזהה מסד הנתונים הזה לא יכול להיות משויך למסד נתונים קיים.

דוגמה:

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, שהוא רשימה אופציונלית של צמדי KEY=VALUE של תגים לקישור.

דוגמה:

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

כברירת מחדל, למסד הנתונים המשוכפל תהיה אותה הגדרת הצפנה כמו למסד הנתונים המקורי. כדי לשנות את הגדרות ההצפנה, משתמשים בארגומנט --encryption-type:

• (ברירת מחדל) use-source-encryption: שימוש באותן הגדרות הצפנה כמו במסד הנתונים של המקור.
• ‫google-default-encryption: שימוש בהצפנה שמוגדרת כברירת מחדל ב-Google.
• ‫customer-managed-encryption: שימוש בהצפנת CMEK. מציינים מזהה מפתח בארגומנט --kms-key-name.

בדוגמה הבאה מוסבר איך להגדיר הצפנת CMEK למסד הנתונים המשוכפל:

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'

Firebase CLI

משתמשים בפקודה firebase firestore:databases:clone כדי לשכפל מסד נתונים:

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

מחליפים את מה שכתוב בשדות הבאים:

• ‫SOURCE_DATABASE: שם מסד הנתונים הקיים שרוצים לשכפל. השם משתמש בפורמט projects/PROJECT_ID/databases/SOURCE_DATABASE_ID.

• ‫DESTINATION_DATABASE: שם מסד הנתונים החדש שנוצר משכפול. השם משתמש בפורמט projects/PROJECT_ID/databases/DESTINATION_DATABASE_ID. השם של מסד הנתונים הזה לא יכול להיות משויך למסד נתונים קיים.

• ‫PITR_TIMESTAMP: חותמת זמן של PITR בפורמט RFC 3339, ברמת פירוט של דקות. לדוגמה: 2025-06-01T10:20:00.00Z או 2025-06-01T10:30:00.00-07:00. אם לא מציינים את השעה, המערכת בוחרת את השעה הנוכחית, מעוגלת כלפי מטה לדקה.

כברירת מחדל, למסד הנתונים המשוכפל תהיה אותה הגדרת הצפנה כמו למסד הנתונים המקורי. כדי לשנות את הגדרות ההצפנה, משתמשים בארגומנט --encryption-type:

• (ברירת מחדל) USE_SOURCE_ENCRYPTION: שימוש באותן הגדרות הצפנה כמו במסד הנתונים של המקור.
• ‫GOOGLE_DEFAULT_ENCRYPTION: שימוש בהצפנה שמוגדרת כברירת מחדל ב-Google.
• ‫CUSTOMER_MANAGED_ENCRYPTION: שימוש בהצפנת CMEK. מציינים מזהה מפתח בארגומנט --kms-key-name.

בדוגמה הבאה מוסבר איך להגדיר הצפנת CMEK למסד הנתונים המשוכפל:

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