匯出及匯入資料

您可以使用 Cloud Firestore 代管的匯出和匯入服務,還原誤刪的資料,也可以將資料匯出以供離線處理。你可以匯出所有文件,或只匯出特定集合。同樣地,您也可以匯入某個匯出項目中的所有資料,或只匯入特定集合。從一個 Cloud Firestore 資料庫匯出的資料可以匯入另一個 Cloud Firestore 資料庫。您也可以Cloud Firestore 匯出內容載入 BigQuery

本頁將說明如何使用匯出與匯入代管服務和 Cloud Storage,匯出及匯入 Cloud Firestore 文件。透過 gcloud 指令列工具和 Cloud Firestore API (RESTRPC),可使用 Cloud Firestore 匯出與匯入代管服務。

事前準備

您必須先完成下列步驟,才能使用匯出與匯入代管服務:

  1. Google Cloud 專案啟用結帳功能。只有 Google Cloud 個已啟用計費功能的專案才能使用匯出與匯入功能。
  2. 為專案建立 Cloud Storage 值區,位置應靠近 Cloud Firestore 資料庫位置。匯出與匯入作業不適用於要求者付費值區。
  3. 請確認您的帳戶具備 Cloud FirestoreCloud Storage 的必要權限。如果您是專案擁有者,您的帳戶必須擁有必要權限。否則,下列角色可授予匯出和匯入作業,以及存取 Cloud Storage 的必要權限:

服務代理權限

匯出和匯入作業會使用 Cloud Firestore 服務代理來授權 Cloud Storage 作業。Cloud Firestore 服務代理程式使用下列命名慣例:

Cloud Firestore 服務代理
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

如要進一步瞭解服務代理,請參閱服務代理

Cloud Firestore 服務代理需要存取匯出或匯入作業中使用的 Cloud Storage 值區。如果 Cloud Storage 值區與 Cloud Firestore 資料庫皆屬同一個專案,Cloud Firestore 服務代理就能根據預設存取該值區

如果 Cloud Storage 值區位於其他專案,則必須授予 Cloud Firestore 服務代理對 Cloud Storage 值區的存取權。

為服務代理指派角色

您可以使用 gsutil 指令列工具指派下列其中一種角色。例如,如要將「儲存空間管理員」角色指派給 Cloud Firestore 服務代理,請執行以下指令:

gsutil iam ch serviceAccount:service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com:roles/storage.admin \
    gs://[BUCKET_NAME]

請將 PROJECT_NUMBER 替換為您的專案編號,用於命名 Cloud Firestore 服務代理。如要查看服務代理名稱,請參閱「查看服務代理名稱」。

或者,您也可以使用 Google Cloud 控制台指派此角色

查看服務代理名稱

您可以前往 Google Cloud 控制台的「Import/Export」頁面,查看匯入和匯出作業用來授權要求的帳戶。您也可以查看資料庫使用的是 Cloud Firestore 服務代理還是舊版 App Engine 服務帳戶。

  1. 查看「匯入/匯出工作執行身分」標籤旁的授權帳戶。

服務代理需要 Cloud Storage 值區的 Storage Admin 角色,才能用於匯出或匯入作業。

為專案設定 gcloud

您可以透過 Google Cloud 控制台或 gcloud 指令列工具啟動匯入和匯出作業。如要使用 gcloud,請設定指令列工具,並透過下列任一方式連線至專案:

匯出資料

匯出作業會將資料庫中的文件複製到 Cloud Storage 值區中的一組檔案。請注意,匯出作業並非在匯出開始時間拍攝的確切資料庫快照。匯出內容可能包含在作業執行期間所做的變更。

匯出所有文件

Google Cloud Console

  1. 前往 Google Cloud 控制台的「Databases」(資料庫) 頁面。

    前往「資料庫」

  2. 從資料庫清單中選取所需資料庫。

  3. 在導覽選單中,按一下「匯入/匯出」

  4. 按一下 [匯出]

  5. 按一下「Export full database」(匯出整個資料庫) 選項。

  6. 在「Choose Destination」下方,輸入 Cloud Storage 值區的名稱,或使用「Browse」按鈕選取值區。

  7. 按一下 [匯出]

控制台會返回「Import/Export」頁面。如果作業成功啟動,這個頁面會在「最近的匯入和匯出」頁面中新增項目。失敗時,頁面會顯示錯誤訊息。

gcloud

使用 firestore export 指令匯出資料庫中的所有文件,並將 [BUCKET_NAME] 替換為 Cloud Storage 值區的名稱。新增 --async 標記,防止 gcloud 工具等待作業完成。

  gcloud firestore export gs://[BUCKET_NAME] \
  --database=[DATABASE]

更改下列內容:

  • BUCKET_NAME:在值區名稱後方加上檔案前置字串 (例如 BUCKET_NAME/my-exports-folder/export-name),即可整理匯出項目。如果您未提供檔案前置字串,則受管理的匯出服務會根據目前的時間戳記建立一個。

  • DATABASE:要匯出文件的資料庫名稱。如要使用預設資料庫,請使用 --database='(default)'

開始匯出作業後,關閉終端機不會取消作業,請參閱「取消作業」。

匯出特定集合

Google Cloud Console

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」頁面

  2. 從資料庫清單中選取所需資料庫。

  3. 在導覽選單中,按一下「匯入/匯出」

  4. 按一下 [匯出]

  5. 按一下「匯出一或多個集合群組」選項。使用下拉式選單選取一或多個集合群組。

  6. 在「Choose Destination」下方,輸入 Cloud Storage 值區的名稱,或使用「Browse」按鈕選取值區。

  7. 按一下 [匯出]

控制台會返回「Import/Export」頁面。如果作業成功啟動,這個頁面會在「最近的匯入和匯出」頁面中新增項目。失敗時,頁面會顯示錯誤訊息。

gcloud

如要匯出特定集合群組,請使用 --collection-ids 標記。這項作業只會匯出具有指定集合 ID 的集合群組。集合群組會包含具有指定集合 ID 的所有集合和子集合 (在任何路徑)。

gcloud firestore export gs://[BUCKET_NAME] \
--collection-ids=[COLLECTION_ID_1],[COLLECTION_ID_2],[SUBCOLLECTION_ID_1] \
--database=[DATABASE]

舉例來說,您可以在 foo 資料庫中設計 restaurants 集合,以納入多個子集合,例如 ratingsreviewsoutlets。如要匯出特定的 restaurantsreviews 集合,指令如下所示:

gcloud firestore export gs://[BUCKET_NAME] \
--collection-ids=restaurants,reviews \
--database='cymbal'

從 PITR 時間戳記匯出

您可以使用 gcloud firestore export 指令,從 PITR 資料將資料庫匯出至 Cloud Storage。您可以匯出時間戳記為過去七天內整分鐘時間戳記的 PITR 資料,但不得早於 earliestVersionTime。如果指定時間戳記的資料已不存在,匯出作業就會失敗。

PITR 匯出作業支援所有篩選器,包括匯出所有文件和匯出特定集合。

  1. 匯出資料庫,並將 snapshot-time 參數指定為所需的復原時間戳記。

    gcloud

    執行下列指令,將資料庫匯出至您的值區。

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

    其中

    • PITR_TIMESTAMP:以分鐘為單位的 PITR 時間戳記,例如 2023-05-26T10:20:00.00Z

    匯出 PITR 資料前,請注意下列事項:

    • 請使用 RFC 3339 格式指定時間戳記。例如:2020-09-01T23:59:30.234233Z
    • 請確認您指定的時間戳記是過去七天內的整分鐘時間戳記,但不得早於 earliestVersionTime。如果資料不再存在於指定的時間戳記,就會產生錯誤。
    • 系統不會向您收取 PITR 匯出作業失敗的費用。

匯入資料

Cloud Storage 中匯出檔案後,您可以將這些檔案中的文件匯入專案或其他專案。關於匯入作業的下列要點:

  • 匯入資料時,系統會使用資料庫現行的索引定義更新必要索引。匯出項目不包含索引定義。

  • 匯入作業不會指派新的文件 ID。匯入會使用匯出時擷取的 ID。在匯入文件時,系統會保留文件 ID,以免 ID 發生衝突。如果已存在 ID 相同的文件,匯入作業會覆寫現有文件。

  • 如果資料庫中的文件沒有受到匯入影響,則匯入後仍會保留在資料庫中。

  • 匯入作業不會觸發 Cloud Functions。快照監聽器會接收與匯入作業相關的更新。

  • .overall_export_metadata 檔案名稱必須與其上層資料夾的名稱相符:

    gs://BUCKET_NAME/OPTIONAL_NAMESPACE_PATH/PARENT_FOLDER_NAME/PARENT_FOLDER_NAME.overall_export_metadata

    如果您移動或複製匯出作業的輸出檔案,請保持 PARENT_FOLDER_NAME.overall_export_metadata 檔案名稱不變。

從匯出項目匯入所有文件

Google Cloud Console

  1. 前往 Google Cloud 控制台的「Databases」(資料庫) 頁面。

    前往「資料庫」頁面

  2. 從資料庫清單中選取所需的資料庫。

  3. 在導覽選單中,按一下「Import/Export」(匯入/匯出)

  4. 按一下「匯入」

  5. 在「Filename」欄位中,輸入完成匯出作業的 .overall_export_metadata 檔案名稱。您可以使用「瀏覽」按鈕選取檔案。

  6. 按一下「匯入」

控制台會返回「Import/Export」頁面。如果作業成功啟動,這個頁面會在「最近的匯入和匯出」頁面中新增項目。失敗時,頁面會顯示錯誤訊息。

gcloud

使用 firestore import 指令,從先前的匯出作業匯入文件。

gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ --database=[DATABASE]

更改下列內容:

  • BUCKET_NAME/EXPORT_PREFIX:匯出檔案的位置。

  • DATABASE:資料庫的名稱。如要使用預設資料庫,請使用 --database='(default)'

例如:

gcloud firestore import gs://my-bucket/2017-05-25T23:54:39_76544/ --database='cymbal'

您可以在 Google Cloud 控制台的 Cloud Storage 瀏覽器中,確認匯出檔案的位置:

開啟 Cloud Storage 瀏覽器

開始匯入作業後,關閉終端機不會取消作業,請參閱「取消作業」。

匯入特定集合

Google Cloud Console

您無法在控制台中選取特定珍藏內容。請改用 gcloud

gcloud

如要從一組匯出檔案匯入特定集合群組,請使用 --collection-ids 旗標。此作業只會匯入含有指定集合 ID 的集合群組。集合群組包含指定集合 ID 的所有集合和子集合 (位於任何路徑)。使用 --database 旗標指定資料庫名稱。如要使用預設資料庫,請使用 --database='(default)'

只有匯出特定集合群組時,系統才會支援匯入特定集合群組。您無法從匯出項目中匯入特定集合。

  gcloud firestore import gs://[BUCKET_NAME]/[EXPORT_PREFIX]/ \
  --collection-ids=[COLLECTION_ID_1],[COLLECTION_ID_2],[SUBCOLLECTION_ID_1] \
  --database=[DATABASE]

匯入 PITR 匯出內容

請按照「匯入所有文件」中的步驟匯入匯出的資料庫。如果資料庫中已有文件,系統就會覆寫該文件。

管理匯出和匯入作業

開始匯出或匯入作業後,Cloud Firestore 會為作業指派不重複的名稱。您可以使用作業名稱來刪除、取消或狀態檢查作業。

作業名稱的前置字串為 projects/[PROJECT_ID]/databases/(default)/operations/,例如:

projects/my-project/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

不過,您可以省略前置字串,為 describecanceldelete 指令指定作業名稱。

列出所有匯出和匯入作業

Google Cloud Console

您可以在 Google Cloud 控制台的「Import/Export」頁面中,查看最近的匯出和匯入作業清單。

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」頁面

  2. 從資料庫清單中選取所需的資料庫。

  3. 在導覽選單中,按一下「匯入/匯出」

gcloud

使用 operations list 指令查看所有執行中的匯出和匯入作業,以及最近完成的作業:

gcloud firestore operations list

查看作業狀態

Google Cloud Console

您可以在 Google Cloud 控制台的「Import/Export」(匯入/匯出工作) 頁面中查看最近匯出或匯入作業的狀態。

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」

  2. 從資料庫清單中選取所需資料庫。

  3. 在導覽選單中,按一下「匯入/匯出」

gcloud

使用 operations describe 指令顯示匯出或匯入作業的狀態。

gcloud firestore operations describe [OPERATION_NAME]

預估完成時間

針對長時間執行作業狀態的要求,系統會傳回 workEstimatedworkCompleted 指標。每個指標都會以位元組數及實體數回傳:

  • workEstimated 會顯示預估作業將處理的位元組總數和文件。如果 Cloud Firestore 無法進行預估,可能會省略這項指標。

  • workCompleted 會顯示目前已處理的位元組數和文件數。作業完成後,這個值會顯示實際處理的位元組和文件總數,可能會大於 workEstimated 的值。

workCompleted 除以 workEstimated 可得出進度的粗估值。這個預估結果可能不準確,因為這取決於延遲統計資料的收集作業。

取消作業

Google Cloud Console

您可以在 Google Cloud 控制台的「Import/Export」頁面中,取消執行中的匯出或匯入作業。

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」

  2. 從資料庫清單中選取所需資料庫。

  3. 在導覽選單中,按一下「匯入/匯出」

在「最近的匯入和匯出作業」表格中,目前執行中的作業會在「已完成」欄中顯示「取消」按鈕。按一下「取消」按鈕,即可停止作業。按鈕會變更為「Cancelling」訊息,然後在作業完全停止時變更為「Cancelled」

主控台中的「最近的匯入和匯出」表格,顯示正在進行的資料匯入作業,以及可停止作業的「取消」選項。

gcloud

使用 operations cancel 指令停止進行中的作業:

gcloud firestore operations cancel [OPERATION_NAME]

取消執行中的作業並不會撤銷該作業。取消的匯出作業會保留已在 Cloud Storage 中匯出的文件,而取消的匯入作業會保留已對資料庫進行的更新。您無法匯入部分完成的匯出內容。

刪除作業

使用 gcloud firestore operations delete 指令,即可從近期作業清單中移除作業。這個指令不會從 Cloud Storage 刪除匯出檔案。

gcloud firestore operations delete [OPERATION_NAME]

匯出與匯入作業的計費和定價

在使用匯出與匯入代管服務前,您需要先為您的 Google Cloud 專案啟用計費功能。

系統會依據 Cloud Firestore 定價中的文件讀取和寫入作業費率表,向您收取匯出與匯入作業的費用。匯出作業會產生每個匯出文件的讀取作業。匯入作業會為每個匯入的文件產生一個寫入作業。

儲存在 Cloud Storage 中的輸出檔案,會計入您的 Cloud Storage 資料儲存空間費用

匯出和匯入作業的費用不會計入您的支出上限。待匯出或匯入作業完成後,系統才會發出關於 Google Cloud 預算的提醒。同樣地,在匯出或匯入作業期間執行的讀取和寫入,將在作業完成後套用至您的每日配額。匯出和匯入作業不會影響主控台的「用量」部分中顯示的用量。

查看匯出和匯入費用

匯出和匯入作業會將 goog-firestoremanaged:exportimport 標籤套用至計費作業。您可以在 Cloud Billing 報表頁面中使用這個標籤查看匯入和匯出作業的相關費用:

從篩選器選單存取 goog-firestoremanaged 標籤。

匯出至 BigQuery

只有在指定 collection-ids 篩選器的情況下,您才能將從 Cloud Firestore 匯出的資料載入 BigQuery。請參閱「Cloud Firestore 匯出內容載入資料」。

BigQuery 欄數上限

BigQuery 規定每個資料表的欄數上限為 10,000 個。Cloud Firestore 匯出作業會為每個集合群組產生 BigQuery 資料表結構定義。在這個架構中,每個集合群組中的專屬欄位名稱都會變成架構資料欄。

如果集合群組的 BigQuery 架構超過 10,000 個資料欄,Cloud Firestore 匯出作業會嘗試將對應欄位視為位元組,以便維持在資料欄限制以下。如果這項轉換作業可將資料欄數降至 10,000 以下,您就可以將資料載入 BigQuery,但無法查詢地圖欄位中的子欄位。如果資料欄數量仍超過 10,000 欄,匯出作業就不會為集合群組產生 BigQuery 結構定義,也無法將資料載入 BigQuery

匯出格式和中繼資料檔案

代管匯出項目輸出內容採用 LevelDB 記錄檔格式

中繼資料檔案

在匯出作業中,會為您指定的每個收藏群組建立中繼資料檔案。中繼資料檔案通常命名為 ALL_NAMESPACES_KIND_[COLLECTION_GROUP_ID].export_metadata

中繼資料檔案屬於通訊協定緩衝區,您可以使用 protoc 通訊協定編譯器進行解碼。舉例來說,您可以將中繼資料檔案解碼,判斷匯出檔案中包含的收藏群組:

protoc --decode_raw < export0.export_metadata

服務代理遷移

Cloud Firestore 會使用 Cloud Firestore 服務代理來授權匯入和匯出作業,而非使用 App Engine 服務帳戶。服務代理程式和服務帳戶會使用下列命名慣例:

Cloud Firestore 個服務代理
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

Cloud Firestore 先前使用 App Engine 預設服務帳戶,而非 Cloud Firestore 服務代理程式。如果您的資料庫仍使用 App Engine 服務帳戶匯入或匯出資料,建議您按照本節的操作說明,改用 Cloud Firestore 服務代理。

App Engine 服務帳戶
PROJECT_ID@appspot.gserviceaccount.com

Cloud Firestore 服務代理是較佳的選擇,因為它是 Cloud Firestore 專屬的。App Engine 服務帳戶由多項服務共用。

查看授權帳戶

您可以在 Google Cloud 控制台的「Import/Export」(匯入/匯出) 頁面中,查看匯入和匯出作業使用哪個帳戶授權要求。您也可以查看資料庫是否已使用 Cloud Firestore 服務代理。

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」

  2. 從資料庫清單中選取所需的資料庫。
  3. 在導覽選單中,按一下「Import/Export」(匯入/匯出)

  4. 查看「匯入/匯出工作執行身分」標籤旁的授權帳戶。

如果您的專案未使用 Cloud Firestore 服務代理,您可以使用下列任一技巧遷移至 Cloud Firestore 服務代理:

第一種方法較佳,因為它可將效果範圍局限於單一 Cloud Firestore 專案。不建議使用第二種方法,因為它不會遷移現有的 Cloud Storage 值區權限。但可在機構層級提供安全法規遵循。

檢查並更新 Cloud Storage 項值區權限,進行遷移

遷移程序分為兩個步驟:

  1. 更新 Cloud Storage 值區權限。詳情請參閱下節。
  2. 確認已遷移至 Cloud Firestore 服務代理。

服務代理值區權限

對於在其他專案中使用 Cloud Storage 值區的任何匯出或匯入作業,您必須授予該值區的 Cloud Firestore 服務代理程式權限。舉例來說,將資料移至其他專案的作業需要存取該專案中的值區。否則,遷移至 Cloud Firestore 服務代理後,這些作業就會失敗。

只要匯入和匯出的流程工作保持在同一個專案中,就不需要變更權限。根據預設,Cloud Firestore 服務代理可存取同一個專案中的資料夾。

更新其他專案中的 Cloud Storage 值區權限,以授予 service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com 服務代理的存取權。將 Firestore Service Agent 角色授予服務代理。

Firestore Service Agent 角色可授予 Cloud Storage 值區的讀取和寫入權限,如果您只需要授予讀取或寫入權限,請使用自訂角色

下節所述的遷移程序可協助您找出可能需要更新權限的 Cloud Storage 桶。

將專案遷移至 Firestore 服務代理人

請完成下列步驟,從 App Engine 服務帳戶遷移至 Cloud Firestore 服務代理。遷移完成後便無法復原。

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」頁面

  2. 從資料庫清單中選取所需資料庫。
  3. 在導覽選單中,按一下「匯入/匯出」

  4. 如果您的專案尚未遷移至 Cloud Firestore 服務代理程式,您會看到說明遷移作業的橫幅,以及「Check Bucket Status」按鈕。接下來,我們將說明如何找出並修正潛在的權限錯誤。

    按一下「查看值區狀態」

    系統會顯示選單,其中包含完成遷移作業的選項,以及 Cloud Storage 值區的清單。清單可能需要幾分鐘才能載入完成。

    這份清單列出最近在匯入和匯出作業中使用的值區,但目前尚未授予 Cloud Firestore 服務代理人讀取和寫入權限。

  5. 請記下專案 Cloud Firestore 服務代理的主要名稱。服務代理名稱會顯示在「應授予存取權的服務代理」標籤下方。
  6. 針對清單中您日後要用於匯入或匯出作業的任何資料夾,請完成下列步驟:

    1. 在這個值層的資料表列中,按一下「修正」。 系統會在新分頁中開啟該儲存桶的權限頁面。

    2. 按一下 [新增]。
    3. 在「新增主體」欄位中,輸入 Cloud Firestore 服務代理的名稱。
    4. 在「Select a role」欄位中,依序選取「Service Agents」>「Firestore Service Agent」
    5. 按一下 [儲存]
    6. 返回含有 Cloud Firestore「匯入/匯出」頁面的分頁。
    7. 針對清單中的其他值區重複上述步驟。請務必查看清單的所有頁面。
  7. 按一下「Migrate to Firestore Service Agent」。如果仍有權限檢查失敗的值區,請按一下「Migrate」確認遷移作業。

    系統會在遷移作業完成後通知您。遷移作業無法復原。

查看遷移狀態

如要確認專案的遷移狀態,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「資料庫」頁面。

    前往「資料庫」

  2. 從資料庫清單中選取所需資料庫。
  3. 在導覽選單中,按一下「匯入/匯出」

  4. 請查看「Import/Export jobs run as」標籤旁的「Principal」(管理員)。

    如果主體為 service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com,表示您的專案已遷移至 Cloud Firestore 服務代理。遷移作業無法復原。

    如果專案尚未遷移,頁面頂端會顯示橫幅,並附上「檢查資料集狀態」按鈕。請參閱遷移至 Firestore 服務代理人,完成遷移作業。

新增全機構政策限制

  • 在貴機構的政策中設定下列限制:

    必須使用 Firestore 服務代理來執行匯入/匯出作業 (firestore.requireP4SAforImportExport)。

    這項限制要求匯入和匯出作業使用 Cloud Firestore 服務代理來授權要求。如要設定這項限制,請參閱「 建立及管理機構政策 」。

套用這項機構政策限制不會自動為 Cloud Firestore 服務代理授予適當的 Cloud Storage 值區權限。

如果限制條件會導致任何匯入或匯出工作流程出現權限錯誤,您可以停用該限制條件,改回使用預設服務帳戶。檢查並更新 Cloud Storage 桶權限後,即可再次啟用限制。