Dataformでテーブル説明、ラベル、タグを設定する

この記事はときは会アドベントカレンダーの8日目です。
Dataformを用いるとテーブルに対する細かな設定をconfigから簡単に行うことができます。テーブル数が多くなった時に少しでも扱いやすくなるためのtipsとしてまとめておきます。

テーブル説明

Dataformからテーブルの説明を入力することができます。これはBigQueryの「詳細」タブから見られるものです。設定する時はconfigのdescriptionに記載します。

config {
  description: "テーブルの説明"
}

またテーブルの各カラムの説明も入力できます。これはBigQueryの「スキーマ」タブから見られます。なおRECOED形式になっているものは、中身の要素ごとに説明を入れられます。

config {
  columns: {
    column1: "column1の説明",
    column2: "column2の説明"
  }
}

さすがに完全にドキュメントの代わりにはならないと思いますが、メモや注意書きは残せそうです。^[1]

ラベル

Dataformからテーブルにラベルを付けることができます。これはBigQueryの詳細から見られるものです。設定する際はconfigのbigquery>labelsにキーバリュー形式で指定します。

config {
  bigquery {
    labels {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

タグ

Dataformからテーブルにタグを付けることができます。設定する際はconfigのtagsに指定します。

config {
  tags: ["test", "dummy"]
}

タグはBigQueryではなくDataform内で利用されるもので、主な用途は以下の2点です。

• ワークフロー構成で更新対象のテーブルを部分的に設定できる
• コンパイルグラフで表示対象のテーブルをフィルターできる

どれも無くても困らないものですが、そこまで設定が難しいわけでもないので、時間が余った時にでもさっと少しずつ改善していくのがおすすめです。
なお、いずれも既存のテーブルをdeclareで宣言する際には付与できないのでご注意を。

脚注

1. 個人的にはコンパイルグラフから見られると理想なんですが、そこまではできないようです