匯入及匯出資料

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

本頁面說明如何使用代管匯出和匯入服務及 Cloud Storage，匯出及匯入 Cloud Firestore 文件。Cloud Firestore 代管匯出和匯入服務可透過 gcloud 指令列工具和 Cloud Firestore API (REST、RPC) 使用。

事前準備

您必須先完成下列工作，才能使用代管匯出和匯入服務：

1. 啟用 Google Cloud 專案的計費功能。只有已啟用計費功能的 Google Cloud 專案，才能使用匯出和匯入功能。
2. 在靠近Cloud Firestore資料庫位置的地方，為專案建立Cloud Storage bucket。您無法使用「要求者付費」值區或快速值區執行匯出和匯入作業。

3. 請確認您的帳戶具備 Cloud Firestore 和 Cloud Storage 的必要權限。如果您是專案擁有者，您的帳戶已具備必要權限。否則，下列角色會授予匯出和匯入作業，以及存取 Cloud Storage 所需的權限：

   • Cloud Firestore 角色： Owner、Cloud Datastore Owner 或 Cloud Datastore Import Export Admin

   • Cloud Storage 角色： Owner 或 Storage Admin

服務代理權限

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

Cloud Firestore 服務代理

service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

如要進一步瞭解服務代理，請參閱「服務代理」。

Cloud Firestore 服務代理需要存取匯出或匯入作業中使用的 Cloud Storage bucket。如果 Cloud Storage bucket 與 Cloud Firestore 資料庫位於相同專案，Cloud Firestore 服務代理預設可存取該 bucket。

如果 Cloud Storage bucket 位於其他專案，您必須授予 Cloud Firestore 服務代理 Cloud Storage bucket 的存取權。

將角色指派給服務代理

您可以使用 gsutil 指令列工具指派下列其中一種角色。例如，如要將 Storage 管理員角色指派給 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. 查看「Import/Export jobs run as」(匯入/匯出工作執行身分) 標籤旁的授權帳戶。

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

為專案設定 gcloud

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

• 使用 Cloud Shell 從 Google Cloud 控制台存取 gcloud。

  開始 Cloud Shell

  確認 gcloud 已設為正確的專案：

  gcloud config set project [PROJECT_ID]
  

• 安裝並初始化 Google Cloud SDK。

匯入資料

在 Cloud Storage 中取得匯出檔案後，您可以將這些檔案中的文件匯回專案，或匯入其他專案。關於匯入作業，請注意下列事項：

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

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

• 如果資料庫中的文件不受匯入作業影響，匯入後仍會保留在資料庫中。

• .overall_export_metadata 檔案名稱必須與其父項資料夾的名稱相符：

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

  如果移動或複製匯出的輸出檔案，請將 PARENT_FOLDER_NAME 和 .overall_export_metadata 檔案名稱保持一致。

• Cloud Firestore 不支援子集合，因此無法將含有子集合的匯出內容匯入 Cloud Firestore 資料庫。

• Firestore 標準版不支援 BSON 類型，因此無法從 BSON 類型的匯出作業匯入 Firestore 標準版資料庫。

• 匯入至 Cloud Firestore 資料庫時，無法從非預設命名空間 (Datastore API) 匯入資料。

  只有在匯出作業包含具有預設命名空間的 --namespace-ids 篩選器時，才能從包含非預設命名空間的資料檔案匯入 Cloud Firestore 資料庫。系統只會匯入預設命名空間的資料。

匯入匯出作業中的所有文件

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

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

匯入特定集合

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

從含有 PITR 資料的匯出項目匯入

請按照「匯入所有文件」或「匯入特定集合」中的相同步驟匯入 PITR 資料。如果資料庫中已有任何文件，系統會覆寫該文件。

匯出資料

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

匯出所有文件

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

匯出特定集合

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

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

從 PITR 時間戳記匯出

您可以從時間點復原資料將資料庫匯出至 Cloud Storage。您可以匯出 PITR 資料，時間戳記為過去七天內的整分鐘時間戳記，但不得早於 earliestVersionTime。如果指定時間戳記已無資料，匯出作業就會失敗。

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

匯出 PITR 資料前，請注意下列事項：

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

gcloud firestore export gs://[BUCKET_NAME_PATH] \
    --snapshot-time=[PITR_TIMESTAMP]

管理匯出和匯入作業

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

作業名稱的前置字串為 projects/[PROJECT_ID]/databases/[DATABASE_ID]/operations/，例如：

projects/my-project/databases/my-database/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

不過，為 describe、cancel 和 delete 指令指定作業名稱時，可以省略前置字元。

列出所有匯出和匯入作業

gcloud firestore operations list

查看作業狀態

gcloud firestore operations describe [OPERATION_NAME]

預估完成時間

要求長時間執行的作業狀態時，會傳回 workEstimated 和 workCompleted 指標。每項指標都會以位元組數和實體數傳回：

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

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

將 workCompleted 除以 workEstimated 可得出進度的粗估值。這項預估值可能不準確，因為取決於延遲的統計資料收集。

取消作業

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 帳單報表頁面中，您可以使用這個標籤查看與匯入和匯出作業相關的費用：

匯出至 BigQuery

您可以將 Cloud Firestore 匯出作業中的資料載入 BigQuery，但前提是您已指定 collection-ids 篩選器。請參閱「從 Cloud Firestore 匯出作業載入資料」。

將 Cloud Firestore 資料載入 BigQuery 時，BSON 資料類型會以 STRING 資料類型表示。

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