備份及還原資料

本頁面說明如何使用 Cloud Firestore 排程備份功能。使用備份功能，避免應用程式層級資料毀損或意外刪除資料。

備份功能可讓您設定備份時程，每天或每週備份指定資料庫。接著，您可以使用這些備份將資料還原至新的資料庫。

備份功能簡介

備份是資料庫在某個時間點的一致副本。備份檔案會包含該時間點的所有資料和索引設定。備份不含資料庫生命週期政策。備份會儲存在與來源資料庫相同的位置。

備份有可設定的保留期限，會儲存到保留期限屆滿或您刪除備份為止。刪除來源資料庫不會自動刪除相關備份。

Cloud Firestore 會儲存與備份相關的中繼資料，以及與資料庫相關的備份時間表。Cloud Firestore 會保留這項中繼資料，直到資料庫的所有備份都過期或遭到刪除為止。

建立或保留備份不會影響您在實際資料庫中讀取或寫入的效能。

費用

使用備份功能時，系統會根據下列項目向您收費：

  • 每個備份使用的儲存空間量。
  • 還原作業的費用會根據備份大小計算。

如需進一步瞭解相關資訊和確切費率，請參閱「定價」頁面。

事前準備

這項功能需要Blaze 定價方案。

必要的角色

如要取得管理備份和備份時間表所需的權限，請要求管理員授予您下列一或多個身分與存取權管理角色：

  • roles/datastore.owner：可完全存取 Cloud Firestore 資料庫

  • 您也可以使用下列角色，但這些角色不會顯示在 Google Cloud 控制台中。使用 Google Cloud CLI 指派這些角色：

    • roles/datastore.backupsAdmin：備份的讀取和寫入權限
    • roles/datastore.backupsViewer：備份的讀取權限
    • roles/datastore.backupSchedulesAdmin：備份時間表的讀取和寫入權限
    • roles/datastore.backupSchedulesViewer：備份排程的讀取權限
    • roles/datastore.restoreAdmin：啟動還原作業的權限

建立及管理備份時間表

以下範例說明如何設定備份時間表。針對每個資料庫，您最多可以設定一個每日備份時間表和一個每週備份時間表。您無法針對不同的星期設定多個每週備份時間表。

您無法設定備份的確切時間。備份作業會在每天不同的時間執行。針對每週備份排程，您可以設定星期幾要備份。

建立備份時間表

使用下列任一工具建立備份時間表。

建立每日備份排程

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，按一下「查看備份」或「編輯設定」，視備份排程是否存在而定。
  3. 按一下「編輯」，即可編輯災難復原設定。
  4. 勾選「Daily」核取方塊，設定保留期間，然後按一下「Save」。
gcloud
如要為資料庫建立備份排程，請使用 gcloud firestore backups schedules create 指令。如要建立每日備份時間表，請將 --recurrence 標記設為 daily：
gcloud firestore backups schedules create \
--database='DATABASE_ID' \
--recurrence=daily \
--retention=RETENTION_PERIOD

更改下列內容：

  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。
Firebase CLI
如要為資料庫建立備份排程，請使用 firebase firestore:databases:backups:schedules 指令。如要建立每日備份時間表，請將 --recurrence 旗標設為 DAILY：
firebase firestore:backups:schedules:create \
--database 'DATABASE_ID' \
--recurrence 'DAILY' \
--retention RETENTION_PERIOD

更改下列內容：

  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。
Terraform
如要建立每日備份時間表，請建立 google_firestore_backup_schedule 資源。
resource "google_firestore_backup_schedule" "daily-backup" {
  project  = PROJECT_ID
  database = DATABASE_ID

  retention = RETENTION_PERIOD_SECONDS

  daily_recurrence {}
}

更改下列內容：

  • PROJECT_ID：專案 ID。
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
    • 您也可以使用 資源參照，指向 google_firestore_database 類型的 Terraform 資源。
  • RETENTION_PERIOD_SECONDS：將這個值設為以秒為單位的值，後面加上「s」。最大值為 8467200s (14 週)。

建立每週備份時間表

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，視是否有備份時程而定，按一下「查看備份」或「編輯設定」。
  3. 按一下「編輯」，即可編輯災難復原設定。
  4. 勾選「每週」核取方塊、選取備份日期、設定保留期間，然後按一下「儲存」。
gcloud
如要建立每週備份時程，請將 --recurrence 旗標設為 weekly：
gcloud firestore backups schedules create \
--database='DATABASE_ID' \
--recurrence=weekly \
--retention=RETENTION_PERIOD \
--day-of-week=DAY
替換下列內容：
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。
  • DAY：備份的星期幾。設為下列其中一個值：
    • SUN 代表星期日
    • MON 代表星期一
    • TUE 代表星期二
    • WED 代表星期三
    • THU 代表星期四
    • FRI 代表星期五
    • SAT 代表星期六
Firebase CLI
如要建立每週備份時程，請將 --recurrence 旗標設為 WEEKLY：
firebase firestore:backups:schedules:create \
--database 'DATABASE_ID' \
--recurrence 'WEEKLY' \
--retention RETENTION_PERIOD
--day-of-week DAY
替換下列內容：
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。
  • DAY：備份的星期幾。設為下列其中一個值：
    • SUNDAY 代表星期日
    • MONDAY 代表星期一
    • TUESDAY 代表星期二
    • WEDNESDAY 代表星期三
    • THURSDAY 代表星期四
    • FRIDAY 代表星期五
    • SATURDAY 代表星期六
Terraform
如要建立每週備份時間表，請建立 google_firestore_backup_schedule 資源。
resource "google_firestore_backup_schedule" "weekly-backup" {
  project  = PROJECT_ID
  database = DATABASE_ID

  retention = RETENTION_PERIOD_SECONDS

  weekly_recurrence {
    day = DAY
  }
}

更改下列內容：

  • PROJECT_ID：專案 ID。
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
    • 您也可以使用 資源參照，指向 google_firestore_database 類型的 Terraform 資源。
  • RETENTION_PERIOD_SECONDS：將這個值設為以秒為單位的值，後面加上「s」。最大值為 8467200s (14 週)。
  • DAY：備份的星期幾。設為下列其中一個值：
    • SUNDAY 代表星期日
    • MONDAY 代表星期一
    • TUESDAY 代表星期二
    • WEDNESDAY 代表星期三
    • THURSDAY 代表星期四
    • FRIDAY 代表星期五
    • SATURDAY 代表星期六

列出備份排程

如要列出資料庫的所有備份時程，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，按一下「查看備份」或「編輯設定」，視備份排程是否存在而定。
  3. 「Disaster recovery」(災難復原) 頁面隨即開啟。本頁面說明備份排程，並列出可用的備份。
gcloud
使用 gcloud firestore backups schedules list 指令。
gcloud firestore backups schedules list \
--database='DATABASE_ID'
請將 DATABASE_ID 替換為資料庫的 ID。使用 '(default)' 做為預設資料庫。
Firebase CLI
使用 firebase firestore:backups:schedules:list 指令。
firebase firestore:backups:schedules:list \
--database 'DATABASE_ID'
請將 DATABASE_ID 替換為資料庫的 ID。使用 '(default)' 做為預設資料庫。

說明備份時程

如要擷取備份時間表的相關資訊，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，按一下「查看備份」或「編輯設定」，視備份排程是否存在而定。
  3. 「Disaster recovery」(災難復原) 頁面隨即開啟。本頁面說明備份排程，並列出可用的備份。
gcloud
使用 gcloud firestore backups schedules describe 指令：
gcloud firestore backups schedules describe \
--database='DATABASE_ID' \
--backup-schedule=BACKUP_SCHEDULE_ID
替換下列內容：
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • BACKUP_SCHEDULE_ID：備份時間表的 ID。列出所有備份時程時，您可以查看每個備份時程的 ID。

更新備份排程

如要更新備份排程的保留期限，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「已排定備份時間」欄中，按一下「查看備份」或「編輯設定」。
  3. 按一下「編輯」，即可編輯災難復原設定。
  4. 編輯備份時間表設定，然後按一下「儲存」。
gcloud
使用 gcloud firestore backups schedules update 指令：
gcloud firestore backups schedules update \
--database='DATABASE_ID' \
--backup-schedule=BACKUP_SCHEDULE_ID \
--retention=RETENTION_PERIOD
替換下列內容：
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • BACKUP_SCHEDULE_ID：備份時間表的 ID。列出所有備份時程時，您可以查看每個備份時程的 ID。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。
Firebase CLI
使用 firebase firestore:backups:schedules:update 指令：
firebase firestore:backups:schedules:update \
BACKUP_SCHEDULE \
--retention RETENTION_PERIOD
替換下列內容：
  • BACKUP_SCHEDULE：備份時間表的完整資源名稱。您可以列出所有備份排程，查看每個備份排程的名稱。
  • RETENTION_PERIOD：將這個值設為最多 14 週 (14w)。

您可以更新備份時間表的保留期限，但無法更新週期。如果您需要採用不同週期性的備份排程，請刪除不再需要的舊備份排程，然後建立採用所需週期性的新備份排程。

刪除備份排程

如要刪除備份時間表，請使用下列任一方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，按一下「查看備份」或「編輯設定」，視備份排程是否存在而定。
  3. 按一下「編輯」，即可編輯災難復原設定。
  4. 編輯備份時間表設定，然後按一下「儲存」。
gcloud
使用 gcloud firestore backups schedules delete 指令：
gcloud firestore backups schedules delete \
--database='DATABASE_ID' \
--backup-schedule=BACKUP_SCHEDULE_ID
替換下列內容：
  • DATABASE_ID：要備份的資料庫 ID。將預設資料庫設為 '(default)'。
  • BACKUP_SCHEDULE_ID：備份時間表的 ID。列出所有備份時程時，您可以查看每個備份時程的 ID。
Firebase CLI
使用 firebase firestore:backups:schedules:delete 指令：
firebase firestore:backups:schedules:delete \
BACKUP_SCHEDULE
替換下列內容：
  • BACKUP_SCHEDULE：備份時間表的完整資源名稱。列出所有備份排程時，您可以查看每個備份排程的名稱。

請注意，刪除備份排程不會刪除此排程已建立的備份。您可以等到保留期限過後再讓備份資料過期，也可以手動刪除備份資料，請參閱「刪除備份資料」一文。

管理備份

列出備份

如要列出可用的備份，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，按一下「查看備份」或「編輯設定」(視是否有備份時程而定)。
  3. 按一下「編輯」，即可編輯災難復原設定。
  4. 編輯備份時間表設定，然後按一下「儲存」。
gcloud
使用 gcloud firestore backups list 指令：
gcloud firestore backups list \
--format="table(name, database, state)"
--format="table(name, database, state)" 標記會將輸出內容格式化為更易讀的格式。如要只列出特定位置的備份，請使用 --location 旗標：
gcloud firestore backups list \
--location=LOCATION \
--format="table(name, database, state)"
將 LOCATION 替換為 Cloud Firestore 位置的名稱。
Firebase CLI
使用 firebase firestore:backups:list 指令：
firebase firestore:backups:list
如要只列出特定位置的備份，請使用 --location 旗標： 
firebase firestore:backups:list \
--location=LOCATION
將 LOCATION 替換為 Cloud Firestore 位置的名稱。

說明備份

如要查看備份的詳細資料，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，視是否有備份時程而定，按一下「查看備份」或「編輯設定」。
  3. 「Disaster recovery」(災難復原) 頁面隨即開啟。本頁面說明備份排程，並列出可用的備份。
gcloud
使用 gcloud firestore backups describe 指令：
gcloud firestore backups describe \
--location=LOCATION \
--backup=BACKUP_ID
替換下列內容：
  • LOCATION：資料庫的位置。
  • BACKUP_ID：備份的 ID。列出所有備份時，您可以查看每個備份的 ID。
Firebase CLI
使用 firebase firestore:backups:get 指令：
firebase firestore:backups:get BACKUP
替換下列內容：
  • BACKUP：備份的完整資源名稱。列出所有備份時，您可以查看每個備份的名稱。

刪除備份

如要刪除備份，請使用下列其中一種方法。

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，視備份時程是否存在而定，點選「查看備份」或「編輯設定」。「Disaster recovery」(災難復原) 頁面隨即開啟。本頁面說明備份排程，並列出可用的備份。
  3. 在「Backups」表格中找出備份的資料列，然後在「Actions」欄中按一下「View more」圖示()。按一下「Delete」。
  4. 使用文字欄位確認操作，然後按一下「Delete」。
gcloud
使用 gcloud firestore backups delete 指令：
gcloud firestore backups delete \
--location=LOCATION \
--backup=BACKUP_ID
替換下列內容：
  • LOCATION：資料庫的位置。
  • BACKUP_ID：備份的 ID。列出所有備份時，您可以查看每個備份的 ID。
Firebase CLI
使用 firebase firestore:backups:delete 指令：
firebase firestore:backups:delete \
BACKUP
替換下列內容：
  • BACKUP：備份的完整資源名稱。您可以列出所有備份，查看每個備份的名稱。

從資料庫備份還原資料

如果執行還原作業，備份中的資料就會寫入新的 Cloud Firestore 資料庫。

如要開始還原作業，請使用下列其中一種方法：

Google Cloud 控制台

  1. 前往 Google Cloud 控制台的「Databases」頁面。

    前往「資料庫」

  2. 在資料庫清單中，找出資料庫的資料列。在「排定的備份作業」欄中，視備份時程是否存在而定，按一下「查看備份」或「編輯設定」。「Disaster recovery」(災難復原) 頁面隨即開啟。本頁面說明備份排程，並列出可用的備份。
  3. 在「Backups」表格中找出備份資料列，然後在「Actions」欄中按一下「View more」()。按一下「Restore with Cloud Shell」。

  4. Cloud Shell 面板會隨即開啟，並顯示 gcloud CLI 指令，以便從所選備份還原資料。將 ID_OF_NEW_DATABASE 替換為資料庫的 ID，然後執行指令。

    執行指令會傳回回應，其中包含有關作業的更多資訊。資料庫很快就會顯示在資料庫清單中。還原作業需要一些時間，且必須完成後才能存取資料庫。

gcloud
使用 gcloud firestore databases restore 指令：
gcloud firestore databases restore \
--source-backup=projects/PROJECT_ID/locations/LOCATION/backups/BACKUP_ID \
--destination-database='DATABASE_ID'
替換下列內容：
  • PROJECT_ID：您的專案 ID。
  • LOCATION：資料庫備份的位置，以及為還原資料建立的新資料庫的位置。
  • BACKUP_ID：備份的 ID。列出所有備份時，您可以查看每個備份的 ID。
  • DATABASE_ID：新資料庫的資料庫 ID。您無法使用已在使用中的資料庫 ID。
輸出內容會包含 metadata、name 和 response 元件： 
metadata:
  '@type': type.googleapis.com/google.firestore.admin.v1.RestoreDatabaseMetadata
  backup: projects/PROJECT_ID/locations/LOCATION/backups/BACKUP_ID
  database: projects/PROJECT_ID/databases/DATABASE_ID
  operationState: PROCESSING
  progressPercentage:
    completedWork: '20'
    estimatedWork: '100'
  startTime: '2023-12-06T14:20:17.398325Z'
name: projects/PROJECT_ID/databases/DATABASE_ID/operations/operation_uuid
response:
  '@type': type.googleapis.com/google.firestore.admin.v1.Database
  createTime: '2023-12-06T14:20:17.398325Z'
  name: projects/PROJECT_ID/databases/DATABASE_ID
  ...
metadata 欄位包含 progressPercentage 元件，詳細說明目前的還原進度，以及 operationState，用於指定還原作業的整體狀態。 如要再次擷取這項資訊，請使用 gcloud firestore operations list：
gcloud firestore operations list --database=DATABASE_ID
或使用上述輸出內容中的 name 欄位，搭配 gcloud firestore operations describe： 
gcloud firestore operations describe OPERATION_NAME
Firebase CLI
使用 firebase firestore:databases:restore 指令：
firebase firestore:databases:restore \
--backup 'BACKUP' \
--database 'DATABASE_ID'
替換下列內容：
  • BACKUP：備份的完整資源名稱。列出所有備份時，您可以查看每個備份的名稱。
  • DATABASE_ID：新資料庫的資料庫 ID。您無法使用已在使用中的資料庫 ID。