Firestore エクスポートからのデータの読み込み

BigQuery では、Firestore マネージド インポートおよびエクスポート サービスを使用して作成された Firestore のエクスポートからのデータの読み込みをサポートしています。マネージド インポートおよびエクスポート サービスでは、Firestore のドキュメントを Cloud Storage バケットにエクスポートします。このエクスポートされたデータを BigQuery テーブルに読み込むことができます。

注: Firestore のエクスポートを読み込む場合、前述の機能の一部はサポートされません。Firestore のエクスポートからデータを読み込む場合、URI ワイルドカードの使用や既存のテーブルへのデータの追加はできません。

制限事項

Firestore エクスポートから BigQuery にデータを読み込む場合は、次の制限事項に注意してください。

• データセットは、エクスポート ファイルが格納される Cloud Storage バケットと同じリージョンまたはマルチリージョンのロケーションに存在する必要があります。
• 指定できる Cloud Storage URI は 1 つのみで、URI ワイルドカードは使用できません。
• Firestore のエクスポートを正しく読み込むには、エクスポート データ内のドキュメントが一貫したスキーマを共有し、個別のフィールド名が 10,000 個未満でなければなりません。
• 新しいテーブルを作成してデータを保存することも、既存のテーブルを上書きすることもできますが、既存のテーブルに Firestore エクスポート データを追加することはできません。
• エクスポート コマンドには、collection-ids フィルタを指定する必要があります。コレクション ID フィルタを指定せずにエクスポートされたデータを BigQuery に読み込むことはできません。

必要な権限

BigQuery にデータを読み込むには、読み込みジョブを実行する権限が必要です。また、新規または既存の BigQuery テーブルやパーティションへのデータの読み込みが可能な権限も必要です。Cloud Storage からデータを読み込む場合は、データを含むバケットに対するアクセス権限も必要です。

BigQuery の権限

BigQuery にデータを読み込むには、少なくとも以下の権限が必要です。これらの権限は、データを新しいテーブルまたはパーティションに読み込む場合や、テーブルまたはパーティションに対してデータの追加や上書きを行う場合に必要になります。

• bigquery.tables.create
• bigquery.tables.updateData
• bigquery.jobs.create

bigquery.tables.create 権限および bigquery.tables.updateData 権限はいずれも、事前定義された以下の Cloud IAM の役割に含まれています。

• bigquery.dataEditor
• bigquery.dataOwner
• bigquery.admin

bigquery.jobs.create 権限は、事前定義された以下の Cloud IAM の役割に含まれています。

• bigquery.user
• bigquery.jobUser
• bigquery.admin

また、bigquery.datasets.create 権限を持つユーザーがデータセットを作成すると、そのデータセットに対する bigquery.dataOwner アクセス権がユーザーに付与されます。bigquery.dataOwner アクセス権により、読み込みジョブを使用してデータセット内のテーブルを作成または更新する権限が付与されます。

BigQuery での Cloud IAM 役割と権限については、アクセス制御をご覧ください。

Cloud Storage の権限

Cloud Storage バケットからデータを読み込むには、storage.objects.get 権限が付与されている必要があります。URI のワイルドカードを使用する場合は storage.objects.list 権限も必要です。

事前定義の Cloud IAM 役割 storage.objectViewer が付与されると、storage.objects.get 権限と storage.objects.list 権限が両方とも与えられます。

Firestore のエクスポート サービスデータの読み込み

BigQuery ウェブ UI、bq コマンドライン ツールまたは API を使用して Firestore のエクスポート メタデータ ファイルからデータを読み込むことができます。

UI やコマンドで Datastore の用語が使用されることもありますが、次の手順は Firestore のエクスポート ファイルで使用できます。Firestore と Datastore のエクスポート形式は同じです。

注: CLI で --projection_fields フラグを使用するか、load ジョブの構成で projectionFields プロパティを設定することで、特定のフィールドを読み込むことが可能です。この機能は、従来の BigQuery ウェブ UI では利用できません。

Console

1. Cloud Console で BigQuery ウェブ UI を開きます。
   BigQuery ウェブ UI に移動
2. ナビゲーション パネルの [リソース] セクションでプロジェクトを展開し、データセットを選択します。[テーブルを作成] をクリックします。データを読み込むプロセスは、空のテーブルを作成するプロセスと同じです。

3. [テーブルの作成] ページの [ソース] セクションで、次の操作を行います。

   • [テーブルの作成元] で [Cloud Storage] を選択します。

   • ソース フィールドに、Cloud Storage の URI を入力します。Cloud Storage バケットは、データセットと同じロケーションに存在する必要があります。Firestore エクスポート ファイルの URI の末尾は [KIND_COLLECTION_ID].export_metadata にします。例: default_namespace_kind_Book.export_metadata。この例では、Book がコレクション ID で、default_namespace_kind_Book が Firestore で生成されたファイルの名前です。

     注: 末尾が overall_export_metadata のファイルは使用しないでください。このファイルは BigQuery では使用できません。

     [KIND_COLLECTION_ID] が Cloud Storage URI で指定されていることを確認します。[KIND_COLLECTION_ID] を含めずに URI を指定すると、次のエラーが表示されます。does not contain valid backup metadata. (error code: invalid)。

   • [ファイル形式] で [Datastore Backup] を選択します。Firestore の場合、適切なオプションは Datastore Backup です。Firestore と Datastore のエクスポート形式は同じです。

4. [テーブルの作成] ページの [送信先] セクションで、次の操作を行います。

   • [データセット名] で、該当するデータセットを選択します。

     

   • [テーブル名] に、BigQuery で作成するテーブルの名前を入力します。

   • [テーブルタイプ] が [ネイティブ テーブル] に設定されていることを確認します。

5. [スキーマ] セクションでは、何もする必要はありません。スキーマは Firestore のエクスポートから推定されます。

6. [詳細オプション] セクションで該当する項目を選択します。既存のテーブルを上書きする場合は、[書き込み設定] を [テーブルを上書きする] に設定します。

   

7. [テーブルを作成] をクリックします。

従来の UI

1. 従来の BigQuery ウェブ UI に移動します。
   BigQuery ウェブ UI に移動
2. ナビゲーション パネルで、データセットにカーソルを合わせて下矢印アイコン をクリックし、[Create new table] をクリックします。

3. [Create Table] ページの [Source Data] セクションで、次の操作を行います。

   • [Create from source] をオンのままにします。

   • [Location] で [Cloud Storage] を選択し、ソース フィールドに Cloud Storage URI を入力します。Cloud Storage バケットは、データセットと同じロケーションに存在する必要があります。Firestore エクスポート ファイルの URI の末尾は [KIND_COLLECTION_ID].export_metadata にします。例: default_namespace_kind_Book.export_metadata。この例では、Book がコレクション ID で、default_namespace_kind_Book が Firestore で生成されたファイルの名前です。

     注: 末尾が overall_export_metadata のファイルは使用しないでください。このファイルは BigQuery では使用できません。

     [KIND_COLLECTION_ID] が Cloud Storage URI で指定されていることを確認します。[KIND_COLLECTION_ID] を含めずに URI を指定すると、次のエラーが表示されます。does not contain valid backup metadata. (error code: invalid)。

   • [File format] で [Datastore Backup] を選択します。Firestore の場合、適切なオプションは Datastore Backup です。Firestore と Datastore のエクスポート形式は同じです。

4. [Create Table] ページの [Destination Table] セクションで、次の操作を行います。

   • [Table name] で適切なデータセットを選択し、BigQuery で作成するテーブルの名前をテーブル名のフィールドに入力します。
   • [Table type] が [Native table] に設定されていることを確認します。

5. [Schema] セクションでは、何もする必要はありません。スキーマは Firestore のエクスポートから推定されます。

6. [Options] セクションで該当する項目を選択します。既存のテーブルを上書きする場合は、[書き込み設定] を [テーブルを上書きする] に設定します。

7. [Create Table] をクリックします。

CLI

bq load コマンドを、source_format を DATASTORE_BACKUP に設定して使用します。--location フラグを指定して、その値をロケーションに設定します。既存のテーブルを上書きする場合は、--replace フラグを追加します。

特定のフィールドのみを読み込むには、--projection_fields フラグを使用します。

bq --location=[LOCATION] load \
--source_format=[FORMAT] \
[DATASET].[TABLE] \
[PATH_TO_SOURCE]

ここで

• [LOCATION] はロケーションです。--location フラグは省略可能です。
• [FORMAT] は DATASTORE_BACKUP です。Firestore の場合、適切なオプションは Datastore Backup です。Firestore と Datastore のエクスポート形式は同じです。
• [DATASET] は、データを読み込むテーブルを含むデータセットです。
• [TABLE] は、データの読み込み先のテーブルです。テーブルが存在しない場合は、新規に作成されます。
• [PATH_TO_SOURCE] は、Cloud Storage URI です。

たとえば、次のコマンドは、gs://mybucket/20180228T1256/default_namespace/kind_Book/default_namespace_kind_Book.export_metadata Firestore エクスポート ファイルを book_data という名前のテーブルに読み込みます。mybucket と mydataset は US マルチリージョン ロケーションに作成されています。

bq --location=US load \
--source_format=DATASTORE_BACKUP \
mydataset.book_data \
gs://mybucket/20180228T1256/default_namespace/kind_Book/default_namespace_kind_Book.export_metadata

API

API を使用して Firestore のエクスポート データを読み込むには、次のプロパティを設定します。

1. Cloud Storage のソースデータを参照する load ジョブ構成を作成します。

2. ジョブリソースの jobReference セクションにある location プロパティでロケーションを指定します。

3. 読み込みジョブの構成で sourceUris を完全修飾の gs://[BUCKET]/[OBJECT] の形式にする必要があります。ファイル（オブジェクト）名の末尾は、[KIND_NAME].export_metadata でなければなりません。Firestore のエクスポートに使用できる URI は 1 つのみです。URI にワイルドカードは使用できません。

4. 読み込みジョブの構成で sourceFormat プロパティを DATASTORE_BACKUP に設定し、データ形式を指定します。Firestore の場合、適切なオプションは Datastore Backup です。Firestore と Datastore のエクスポート形式は同じです。

5. 特定のフィールドだけを読み込むには、projectionFields プロパティを設定します。

6. 既存のテーブルを上書きする場合は、writeDisposition プロパティを WRITE_TRUNCATE に設定して、書き込み処理を指定します。

注: 読み込みプロセスをスキップする場合、エクスポートを外部データソースとして設定すると、エクスポートに対して直接クエリを実行できます。詳細については、外部データソースをご覧ください。

Firestore のオプション

BigQuery が Firestore のエクスポート データを解析する方法を変更するには、次のオプションを指定します。

CSV のオプション	従来の UI のオプション	CLI のフラグ	BigQuery API のプロパティ	説明
Projection フィールド	なし	--projection_fields	projectionFields	（省略可）Firestore のエクスポートから読み込むドキュメント フィールドを示すカンマ区切りのリスト。デフォルトでは、BigQuery はすべてのフィールドを読み込みます。フィールド名では大文字と小文字が区別されます。また、フィールドはエクスポート内に存在する必要があります。map.foo などのマップ フィールド内にフィールドパスを指定することはできません。
許可される不良レコード数	許容されるエラー数	--max_bad_records	maxBadRecords	（オプション）BigQuery でジョブの実行時に無視できる不良レコードの最大数。不良レコードの数がこの値を超えると、ジョブ結果で「無効」エラーが返されます。デフォルト値は 0、つまりすべてのレコードが有効である必要があります。

データ型の変換

BigQuery は、Firestore エクスポート ファイルの各ドキュメントのデータを BigQuery のデータ型に変換します。次の表に、変換前と変換後のデータ型を示します。

Firestore のデータ型	BigQuery のデータ型
配列	RECORD
ブール値	BOOLEAN
参照	RECORD
日時	TIMESTAMP
地図	RECORD
浮動小数点数	FLOAT
地理的座標	RECORD [{"lat","FLOAT"}, {"long","FLOAT"}]
整数	INTEGER
文字列	STRING（64 KB で切り捨て）

Firestore のキーのプロパティ

Firestore の各ドキュメントには、ドキュメント ID やドキュメント パスなどの情報を含む一意のキーが設定されています。次の表に示すように、BigQuery は、情報の各部分のネストされたフィールドで、キーに対して RECORD データ型（STRUCT とも呼ばれます）を作成します。

キーのプロパティ	説明	BigQuery のデータ型
__key__.app	Firestore アプリの名前。	STRING
__key__.id	ドキュメントの ID、または null（__key__.name が設定されている場合）。	INTEGER
__key__.kind	ドキュメントのコレクション ID。	STRING
__key__.name	ドキュメントの名前、または null（__key__.id が設定されている場合）。	STRING
__key__.namespace	Firestore はカスタム名前空間をサポートしていません。デフォルトの名前空間は空白の文字列で表されます。	STRING
__key__.path	ドキュメントのパス: ドキュメントとルート コレクションからのコレクション ペアのシーケンス例: "Country", "USA", "PostalCode", 10011, "Route", 1234。	STRING