エンティティのエクスポートとインポート

このページでは、マネージド エクスポートとインポート サービスを使用して Datastore モードの Cloud Firestore エンティティをエクスポート、インポートする方法について説明します。マネージド エクスポートとインポート サービスは、gcloud コマンドライン ツールや Cloud Datastore Admin API(RESTRPC)を介して利用できます。

マネージド エクスポートおよびインポート サービスを利用すると、誤って削除したデータを復元したり、オフライン処理のためにデータをエクスポートしたりできます。すべてのエンティティをエクスポートすることも、特定の種類のエンティティだけをエクスポートすることもできます。同様に、エクスポートされたすべてのデータをインポートすることも、特定の種類のみをインポートすることもできます。マネージド エクスポートおよびインポート サービスを利用する際は、次の点を考慮してください。

  • エクスポート サービスでは、結果整合性読み取りが使用されます。エクスポートが単一の時点で発生すると想定することはできません。エクスポートの開始後に書き込まれたエンティティがエクスポートに含まれる場合も、エクスポートの開始前に書き込まれたエンティティがエクスポートから除外される場合もあります。

  • インデックスはエクスポートに含まれません。データをインポートすると、データベースの現在のインデックス定義を使用して、必要なインデックスが自動的に再構築されます。エンティティごとのプロパティ値のインデックス設定はエクスポートされ、インポート時に適用されます。

  • インポートでは、エンティティに新しい ID は割り当てられません。インポートでは、エクスポート時の ID が使用され、同じ ID のエンティティはすべて上書きされます。これらの ID は、エンティティのインポート中は予約された状態になります。これにより、インポートの実行中に書き込みが有効になっても、新しいエンティティと ID が競合することはありません。

  • データベース内のエンティティがインポートの影響を受けない場合、そのエンティティはインポート後もデータベースに維持されます。

  • ある Datastore モードのデータベースからエクスポートされたデータを、別の Datastore モードのデータベース(別のプロジェクト内のものでも可)にインポートできます。

  • マネージド エクスポートおよびインポート サービスでは、同時に実行できるエクスポートとインポートの数が 50 に制限されています。プロジェクトで 1 分間に送信できるエクスポート / インポート リクエストは最大 20 個までです。

  • マネージド エクスポートの出力では、LevelDB ログ形式が使用されます。

始める前に

マネージド エクスポートおよびインポート サービスを使用するには、その前に、次のタスクを完了する必要があります。

  1. Google Cloud Platform プロジェクトに対して課金が有効になっていることを確認します。エクスポート機能とインポート機能を使用できるのは、課金が有効になっている GCP プロジェクトのみです。課金について詳しくは、インポートおよびエクスポートの課金と料金をご覧ください。

  2. Datastore モードの Cloud Firestore データベース ロケーションと同じロケーションを使用して、プロジェクトの Cloud Storage バケットを作成します。すべてのエクスポートとインポートで Cloud Storage を使用するため、Cloud Storage バケットと Datastore モードの Cloud Firestore データベースで同じロケーションを使用する必要があります。エクスポート / インポート オペレーションには、リクエスト元による支払いバケットは使用できません。

  3. ユーザー アカウントに、datastore.databases.export 権限(データをエクスポートする場合)または datastore.databases.import 権限(データをインポートする場合)を付与する IAM 役割を割り当てます。たとえば、Cloud Datastore Import Export Admin 役割はこの両方の権限を付与します。

  4. ユーザー アカウントに、Cloud Storage バケットに対する読み取り権限または書き込み権限を付与する Cloud Storage IAM 役割を割り当てます。

環境の設定

データをエクスポートまたはインポートする前に、gcloud ツールの環境変数を設定し、ユーザー アカウントを使用して認証を行う必要があります。

  1. GCP プロジェクト ID の環境変数を設定します。

    PROJECT_ID="YOUR_PROJECT_ID"
    
  2. この変数を使用して、プロジェクトを gcloud ツールのアクティブ構成として設定します。

    gcloud config set project ${PROJECT_ID}
    
  3. gcloud ツールを使用して認証を行います。

    gcloud auth login
    
  4. Cloud Storage バケット ID の環境変数を設定します。

    BUCKET="YOUR_BUCKET_NAME[/NAMESPACE_PATH]"
    

    ここで、YOUR_BUCKET_NAME は Cloud Storage バケットの名前、NAMESPACE_PATH はオプションの Cloud Storage 名前空間パスです(これは Datastore モードの名前空間ではありません)。Cloud Storage 名前空間パスの詳細については、オブジェクト名に関する考慮事項をご覧ください。

マネージド エクスポートおよびインポート オペレーションの開始

このセクションでは、マネージド エクスポートまたはインポート オペレーションを開始する方法と、オペレーションの進行状況を確認する方法について説明します。

エンティティのエクスポート

次のコマンドを使用して、デフォルトの名前空間にあるすべての種類のエンティティをエクスポートします。このオペレーションが完了するまで gcloud ツールが待機しないようにするには、--async フラグを追加します。

gcloud

gcloud datastore export --namespaces="(default)" gs://${BUCKET}

プロトコル

curl 
-H "Authorization: Bearer $(gcloud auth print-access-token)"
-H "Content-Type: application/json"
https://datastore.googleapis.com/v1/projects/${PROJECT_ID}:export
-d '{ "outputUrlPrefix": "gs://'${BUCKET}'", "entityFilter": { "namespaceIds": [""], }, }'

種類や名前空間の特定のサブセットをエクスポートするには、エンティティ フィルタに種類と名前空間 ID の値を指定します。

gcloud

gcloud datastore export --kinds="KIND1,KIND2" --namespaces="NAMESPACE1,NAMESPACE2" gs://${BUCKET}

プロトコル

curl 
-H "Authorization: Bearer $(gcloud auth print-access-token)"
-H "Content-Type: application/json"
https://datastore.googleapis.com/v1/projects/${PROJECT_ID}:export
-d '{ "outputUrlPrefix": "gs://'${BUCKET}'", "entityFilter": { "kinds": ["KIND1", "KIND2", …], "namespaceIds": ["NAMESPACE1", "NAMESPACE2", …], }, }

エンティティのインポート

以下のコマンドを使用して、以前にマネージド エクスポートおよびインポート サービスを使用してエクスポートされたエンティティをインポートします。このオペレーションが完了するまで gcloud ツールが待機しないようにするには、--async フラグを追加します。

gcloud

gcloud datastore import gs://${BUCKET}/[PATH]/[FILE].overall_export_metadata

プロトコル

curl 
-H "Authorization: Bearer $(gcloud auth print-access-token)"
-H "Content-Type: application/json"
https://datastore.googleapis.com/v1/projects/${PROJECT_ID}:import
-d '{ "inputUrl": "gs://'${BUCKET}'/[PATH]/[FILE].overall_export_metadata", }'

Google Cloud Platform Console の Cloud Storage UI を使用してバケットを表示するか、エクスポートの完了後に gcloud datastore export 出力または ExportEntitiesResponse を調べることで、インポート ロケーションに使用されている値を確認できます。インポート ロケーションの値の例を以下に示します。

gcloud

gs://${BUCKET}/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata

プロトコル

"outputUrl": "gs://'${BUCKET}'/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata",

非同期エクスポートまたはインポート

エクスポートとインポートには長い時間がかかります。エクスポートまたはインポートを実行するときに、--async フラグを指定すると、gcloud ツールがオペレーションの完了を待たないように設定できます。

エクスポートまたはインポート オペレーションが開始した後は、gcloud ツールから返された ID を使用して、オペレーションのステータスを確認できます。次に例を示します。

gcloud datastore operations describe ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI

--async フラグを忘れた場合は、Ctrl+c を使用してツールがオペレーションを待機するのを停止することもできます。Ctrl+c を入力してもオペレーションはキャンセルされません。

長時間実行オペレーションの管理

長時間実行オペレーションとは、完了までに膨大な時間がかかる可能性があるメソッドの呼び出しです。Datastore モードのデータベースは、データのエクスポートまたはインポート時に長時間実行オペレーションを作成します。

たとえば、エクスポートが開始されると、Datastore モードのデータベースはエクスポート ステータスを追跡するための長時間実行オペレーションを作成します。エクスポートの開始からの出力を以下に示します。

{
  "name": "projects/[YOUR_PROJECT_ID]/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
    "common": {
      "startTime": "2017-05-25T23:54:39.583780Z",
      "operationType": "EXPORT_ENTITIES"
    },
    "progressEntities": {},
    "progressBytes": {},
    "entityFilter": {
      "namespaceIds": [
        ""
      ]
    },
    "outputUrlPrefix": "gs://[YOUR_BUCKET_NAME]"
  }
}

name フィールドの値は、長時間実行オペレーションの ID です。

Datastore モードの Cloud Firestore では、オペレーション Admin API を使用して、長時間実行オペレーションのステータスを確認したり、長時間実行オペレーションをキャンセル、削除、一覧表示したりできます。

方法 説明
projects.operations.cancel 長時間実行オペレーションをキャンセルします。
projects.operations.delete 長時間実行オペレーションを削除します。

注: オペレーションを削除しても、キャンセルはされません。
projects.operations.get 長時間実行オペレーションのステータスを取得します。
projects.operations.list 長時間実行オペレーションを一覧表示します。

長時間実行オペレーションの一覧表示

長時間実行オペレーションを一覧表示するには、次のコマンドを実行します。

gcloud

gcloud datastore operations list

プロトコル

curl 
-H "Authorization: Bearer $(gcloud auth print-access-token)"
https://datastore.googleapis.com/v1/projects/${PROJECT_ID}/operations

次の出力例には、最近完了したエクスポート オペレーションが示されています。完了後のオペレーションには数日間アクセスできます。

{
  "operations": [
    {
      "name": "projects/[YOUR_PROJECT_ID]/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
      "metadata": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
        "common": {
          "startTime": "2017-12-05T23:01:39.583780Z",
          "endTime": "2017-12-05T23:54:58.474750Z",
          "operationType": "EXPORT_ENTITIES"
        },
        "progressEntities": {
          "workCompleted": "21933027",
          "workEstimated": "21898182"
        },
        "progressBytes": {
          "workCompleted": "12421451292",
          "workEstimated": "9759724245"
        },
        "entityFilter": {
          "namespaceIds": [
            ""
          ]
        },
        "outputUrlPrefix": "gs://[YOUR_BUCKET_NAME]"
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesResponse",
        "outputUrl": "gs://[YOUR_BUCKET_NAME]/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata"
      }
    }
  ]
}

エンティティをインポートするときには、input_url 値を使用します。

完了時間の見積もり

長時間実行オペレーションのステータスをリクエストすると、workEstimated 指標と workCompleted 指標が返されます。これらの指標はいずれも、バイト数とエンティティ数の両方で返されます。workEstimatedデータベース統計情報に基づき、オペレーションが処理すると推定されるバイト数とエンティティ数の合計を示します。workCompleted は、それまでに処理されたバイト数とエンティティ数を示します。オペレーションが完了すると、実際に処理されたバイト数とエンティティ数の合計が workCompleted に反映されます。この値は、workEstimated の値より大きい場合もあります。

進行した割合を大まかに得るには、workCompletedworkEstimated で割ります。この割合は、最新の統計情報コレクションとの間に遅延があるために正確ではない可能性があります。

例として、エクスポート オペレーションの進行状況を次に示します。

{
  "operations": [
    {
      "name": "projects/[YOUR_PROJECT_ID]/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
      "metadata": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
        ...
        "progressEntities": {
          "workCompleted": "1",
          "workEstimated": "3"
        },
        "progressBytes": {
          "workCompleted": "85",
          "workEstimated": "257"
        },
        ...

マネージド エクスポートおよびインポートの課金と料金

マネージド エクスポートおよびインポート サービスを使用する前に、Google Cloud Platform プロジェクトに対する課金を有効にする必要があります。エクスポート オペレーションとインポート オペレーションでは、Datastore モードの料金に記載されている金額がエンティティの読み込みと書き込みに対して課金されます。

エクスポートおよびインポート オペレーションのコストは、App Engine の使用量上限の計算対象になりません。また、Google Cloud Platform の予算を設定している場合、エクスポートまたはインポート オペレーションは完了するまでアラートをトリガーすることはありません。同様に、エクスポートまたはインポート オペレーションの実行中に行われる読み取りと書き込みは、オペレーションが完了してから 1 日の割り当てに適用されます。

課金の詳細については、課金と支払いのサポートをご覧ください。

権限

エクスポートおよびインポート オペレーションを開始するには、ユーザー アカウントの IAM 役割によって datastore.databases.exportdatastore.databases.import 権限が付与されている必要があります。たとえば、Cloud Datastore Import Export Admin 役割はこの両方の権限を付与します。同様に、curl を使用してコマンドラインから REST リクエストを発行する場合は、これらの権限を付与する IAM 役割をユーザー アカウントに割り当てる必要があります。Datastore モードのデータベースの権限の詳細については、Identity and Access Management(IAM)をご覧ください。

サンプル cron アプリを使用する場合、そのリクエストでは GCP プロジェクトの App Engine デフォルト サービス アカウントが使用されます。この App Engine デフォルト サービス アカウントに、Cloud Datastore Import Export Admin 役割または datastore.databases.export 権限を付与する別の役割を付与する必要があります。

加えて、すべてのエクスポート リクエストに関して、リクエストを発行するアカウントと、GCP プロジェクトの App Engine デフォルト サービス アカウントの両方に、Cloud Storage バケットに対する次の権限を付与する IAM 役割が設定されている必要があります。

権限名 説明
storage.buckets.get バケットのメタデータを読み取る(IAM ポリシーを除く)。
storage.objects.create 新しいオブジェクトをバケットに追加する。
storage.objects.list バケット内のオブジェクトを一覧表示する。一覧表示するときに、オブジェクトのメタデータも読み取る(ACL を除く)。

Cloud Storage の役割の一覧については、Cloud Storage IAM 役割をご覧ください。たとえば、Storage Admin または Storage Legacy Bucket Writer 役割には、エクスポートに必要なすべての Cloud Storage 権限が含まれています。これらの役割は、プロジェクト全体または特定のバケットに適用できます。Storage Object Creator 役割には、エクスポートに必要なすべての Cloud Storage の権限が含まれているわけではないことに注意してください。

インポート リクエストの場合は、リクエストを発行するアカウントと GCP プロジェクトのデフォルト サービス アカウントの両方に、Cloud Storage バケットに対する次の権限を付与する IAM 役割が割り当てられている必要があります。

権限名 説明
storage.objects.get オブジェクトのデータとメタデータを読み取る(ACL を除く)。
storage.objects.list バケット内のオブジェクトを一覧表示する。一覧表示するときに、オブジェクトのメタデータも読み取る(ACL を除く)。

Storage Object Viewer 役割を付与すると、インポートに必要なすべての権限が付与されます。

Cloud Datastore 管理バックアップとの違い

以前に Cloud Datastore 管理コンソールをバックアップ用に使用していた場合は、次の違いに注意してください。

  • マネージド エクスポートおよびインポート サービスの GUI はありません。

  • マネージド エクスポートによって作成されたエクスポートは、Cloud Datastore 管理コンソールには表示されません。マネージド エクスポートおよびインポートは新しいサービスであり、GCP Console で管理する App Engine のバックアップおよび復元機能とはデータを共有しません。

  • マネージド エクスポートおよびインポート サービスは、Cloud Datastore 管理バックアップと同じメタデータをサポートしているわけではありません。また、データベースに進行状況を保管することはしません。エクスポートおよびインポート オペレーションの進行状況を確認する方法については、長時間実行オペレーションの管理をご覧ください。

  • マネージド エクスポートおよびインポート オペレーションのサービスログを表示することはできません。

  • マネージド インポート サービスには、Cloud Datastore 管理バックアップ ファイルとの後方互換性があります。マネージド インポート サービスを使用して Cloud Datastore 管理バックアップ ファイルをインポートすることはできますが、Cloud Datastore 管理コンソールを使用してマネージド エクスポートの出力をインポートすることはできません。

BigQuery へのインポート

マネージド エクスポートからのデータを BigQuery にインポートするには、Datastore モードのバックアップからのデータの読み込みをご覧ください。

制限事項

  • エンティティ フィルタを指定せずにエクスポートされたデータは、BigQuery に読み込むことができません。BigQuery にデータをインポートするには、エクスポート リクエストでエンティティ フィルタに 1 種類以上の名前を含める必要があります。
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Cloud Datastore ドキュメント