本頁面說明如何使用代管匯入和匯出功能,將 Cloud Firestore 資料從一個專案移至另一個專案。這項功能可用於設定開發環境,或在將應用程式永久遷移至其他專案時使用。本頁面的範例說明如何從來源專案匯出資料,然後將資料匯入目的地專案。在專案之間移動資料的步驟如下:
- 建立 Cloud Storage bucket,用來存放來源專案的資料。
- 將來源專案的資料匯出至 bucket。
- 授予目的地專案讀取 bucket 的權限。
- 將 bucket 中的資料匯入目的地專案。
事前準備
您必須先完成下列工作,才能使用代管匯出和匯入服務:
- 為來源專案和目的地專案啟用計費功能。只有已啟用計費功能的 Google Cloud 專案,才能使用匯出和匯入功能。
-
確認您的帳戶在來源專案和目的地專案中具備必要的 Cloud IAM 權限。如果您是這兩項專案的擁有者,您的帳戶就具備必要權限。否則,下列 Cloud IAM 角色會授予 Cloud Firestore 匯出和匯入作業所需的權限:
Owner、Cloud Datastore Owner或Cloud Datastore Import Export Admin專案擁有者可以按照「授予存取權」中的步驟,授予其中一個角色。
-
設定
gcloud指令列工具,並透過下列任一方式連線至專案:-
使用 Cloud Shell 透過 Google Cloud 控制台存取
gcloud。確認
gcloud已設為正確的專案:gcloud config set project [SOURCE_PROJECT_ID]
-
-
在新專案中設定索引。來源和目的地專案的複合索引應相符。請先設定索引,以免重複處理每份文件。
從來源專案匯出資料
如要匯出資料,請為 Cloud Firestore 匯出檔案建立 Cloud Storage bucket,然後啟動匯出作業。
建立 Cloud Storage bucket
在 Cloud Firestore 資料庫所在位置建立 Cloud Storage bucket。如要查看資料庫位置,請參閱專案位置資訊設定。您無法使用「要求者付費」bucket 或快速 bucket 執行匯出和匯入作業。
如果 Cloud Storage bucket 不在來源專案中,您必須將 bucket 的存取權授予來源專案的預設服務帳戶。每個 Google Cloud 專案都會自動建立預設服務帳戶,名稱為 PROJECT_ID@appspot.gserviceaccount.com。Cloud Firestore 匯出作業會使用這個預設服務帳戶,授權 Cloud Storage bucket 作業。如要授予預設服務帳戶來源 bucket 的存取權,請授予 Storage Admin 角色。
您可以使用 Cloud Shell 中的 gsutil 工具授予這個角色:
gsutil iam ch serviceAccount:[service-PROJECT_NUMBER]@gcp-sa-firestore.iam.gserviceaccount.com :roles/storage.admin\ gs://[BUCKET_NAME]@
您也可以在 Google Cloud 控制台中授予這個角色。
停用寫入作業 (選用)
如果您在執行匯出作業時,應用程式仍持續寫入資料庫,則匯出檔案可能無法擷取所有寫入內容。如要從一致的狀態匯出資料,請更新安全性規則並停止所有 Admin SDK 作業,停用資料庫的寫入功能。
更新安全性規則
在 Firebase 控制台中,依序前往「Databases & Storage」>「Firestore」>「Rules」分頁。
更新來源專案安全性規則,拒絕所有寫入作業。例如:
// Deny write access to all users under any conditions service cloud.firestore { match /databases/{database}/documents { match /{document=**} { allow write: if false; } // Reads do not affect export operations // Add your read rules here } }停止 Admin SDK 的寫入作業
安全性規則不會阻止使用 Firebase Admin SDK 或 Google Cloud 伺服器用戶端程式庫建立的特殊權限伺服器環境寫入資料。請務必關閉或更新伺服器,停止管理伺服器的寫入作業。
開始匯出作業
使用 gcloud firestore export 指令,從來源專案匯出資料。您可以匯出所有資料,或只匯出特定集合群組。將 [SOURCE_BUCKET] 替換為 Cloud Storage bucket 名稱:
- 匯出所有資料
-
gcloud firestore export gs://[SOURCE_BUCKET] --async
- 匯出特定集合群組
-
gcloud firestore export gs://[SOURCE_BUCKET] --collection-ids=[COLLECTION_GROUP_ID_1],[COLLECTION_GROUP_ID_2] --async
請記下匯出作業的 outputURIPrefix,稍後會用到。根據預設,Cloud Firestore 會根據時間戳記,在匯出檔案中加入前置字串:
outputUriPrefix: gs://[SOURCE_BUCKET]/2019-03-05T20:58:23_56418
匯出作業執行時,您可以使用 firestore operations list 指令查看作業進度:
gcloud firestore operations list
將資料匯入目的地專案
接著,請授予目的地專案 Cloud Firestore 資料檔案的存取權,並啟動匯入作業。
授予目的地專案資料檔案存取權
開始匯入作業前,請務必確認目的地專案可以存取 Cloud Firestore 資料檔案。
將資料檔案移至本機 bucket
如果來源 bucket 位置與目的地專案的 Cloud Firestore 位置不同,您必須將資料檔案移至與目的地專案位於相同位置的 Cloud Storage bucket。
請按照「移動 bucket 和重新命名」中的步驟,將資料檔案移至其他 Cloud Storage bucket。在下列所有步驟中,請將這個新 bucket 做為 [SOURCE_BUCKET]。
將來源 bucket 的存取權授予專案服務帳戶
如果來源 bucket 不在目的地專案中,您必須將來源 bucket 的存取權授予目的地專案的預設服務帳戶。預設服務帳戶名稱為 [DESTINATION_PROJECT_ID]@appspot.gserviceaccount.com。如要將來源 bucket 的存取權授予預設服務帳戶,請授予適當的 bucket 存取權限。
您可以使用 Cloud Shell 中的 gsutil 工具授予必要角色:
gsutil iam ch serviceAccount:[DESTINATION_PROJECT_ID]@appspot.gserviceaccount.com:legacyBucketReader,legacyObjectReader \ gs://[SOURCE_BUCKET]
您也可以在 Google Cloud 控制台中授予這個角色。
開始匯入作業
開始匯入作業前,請確認 gcloud 已設為正確的專案:
gcloud config set project [DESTINATION_PROJECT_ID]
使用 gcloud firestore import 指令,將來源 bucket 中的資料匯入目的地專案:
gcloud firestore import gs://[SOURCE_BUCKET]/[EXPORT_PREFIX] --async
其中 [EXPORT_PREFIX] 與匯出作業 outputUriPrefix 中的前置字串相符。例如:
gcloud firestore import gs://[SOURCE_BUCKET]/2019-03-05T20:58:23_56418 --async
匯出作業執行時,您可以使用 firestore operations list 指令查看作業進度:
gcloud firestore operations list