BigQueryのデータマート定義でテーブル・カラムの説明を設定する方法

BigQueryのデータマート定義のデータ転送モードでは、テーブル・カラム説明設定 にて出力先のテーブルとカラムの説明を設定できます。この機能により、既存のテーブルに全件洗い替えを行う場合であっても、既存のテーブルとカラムの説明を維持することができます。

設定方法

1. BigQueryのデータマート定義STEP2にてクエリ実行モードにデータ転送モードを選択してください。
2. クエリ設定にて、出力先データセットや出力先テーブル、クエリを設定してください。
3. クエリ設定内にある「テーブル・カラム説明設定」を開いてください。

初期状態では「テーブル説明」のみ表示され、対象テーブルの説明を入力できます。

クエリのプレビューを実行するとカラム一覧が表示され、各カラムに対して説明を入力できます。

「出力先テーブルの説明を取り込む」をクリックすると、出力先のテーブルのスキーマとテーブル・カラムの説明を取り込みます。

※ 増分更新・SCD Type 2（履歴保持）モードでは、テーブル・カラム説明設定に表示されるカラム一覧は、実行クエリプレビューの結果に基づきます。実行クエリプレビューを実行してからカラム説明を入力してください。

「テーブル・カラム説明設定」の入力内容と動作

説明を入力した場合

TROCCOで入力した説明は、ジョブ実行後にBigQuery側に反映されます。

例：

ジョブ実行前のテーブル：

テーブル・カラム説明設定：order_id に「注文ID」と入力

ジョブ実行後のテーブル：

説明を削除した場合

TROCCOで一度説明を入力した後、フォームから入力を削除して保存すると、ジョブ実行後にBigQuery側の説明が削除されます。

例：

ジョブ実行前のテーブル：

テーブル・カラム説明設定：
1. 「出力先テーブルの説明を取り込む」をクリックして出力先のテーブルの説明をフォームに反映してください。
2. amount の説明を削除してください。

ジョブ実行後のテーブル：

未設定の場合

「テーブル・カラム説明設定」に一度も入力していない場合、BigQuery側の既存のテーブルの説明がそのまま保持されます。

例：

ジョブ実行前のテーブル：

テーブル・カラム説明設定：未設定

ジョブ実行後のテーブル：

※「テーブル・カラム説明設定」に入力して保存した場合、未設定の状態に戻すことはできません。入力を削除して空欄で保存すると、「説明を削除した場合」のように削除の指示となります。

既存のテーブルと異なるスキーマで全件洗い替えを行う場合

全件洗い替えモードではBigQuery側のテーブルが再作成されます。もし既存のテーブルと出力されるテーブルのスキーマ構成が異なる場合、説明の反映はカラム名を基準に行われます。

• 名前が一致するカラム： 既存の説明が保持されます。
• 新たに追加されたカラム： 説明は未入力のままになります。
• 削除されたカラム： カラムが削除されるため、カラムの説明は残りません。

例：

ジョブ実行前のテーブル：

クエリ：note カラムを削除し、status カラムを追加

テーブル・カラム説明設定：未設定

ジョブ実行後のテーブル：