テーブル定義書を簡単に作成しよう

カスタマーオンボーディングチームの塚原 一喜です。
オンボーディングの段階で、テーブル定義書の作成をどうするかという話が増えてきましたので、Treasure Data CDPにおけるテーブル定義書の管理方法についてご説明します。
具体的な管理方法として

1. コンソールのテーブルSchema情報での管理
2. Infomation Schemaを使ったスプレッドシートなどへの出力

の2パターンが考えられます。それぞれのやり方についてご説明します。

1.コンソールのテーブルSchema情報での管理

Treasure Data CDPのテーブルにはSchema情報が保存されています。DESCRIPTIONは日本語の記述も可能ですので、そちらで管理していくやり方を推奨しています。Treasure Data CDPは複数のユーザーアカウントから同一テーブルに分析クエリを発行していく運用になることが多いため、「このカラムってなんの情報だったっけ？」となったとき、コンソール内ですぐに確認ができるようになります。

1.確認方法

2.DESCRIPTIONの追加

3.編集

2.Infomation Schemaを使ったスプレッドシートなどへの出力

オーソドックスなエクセルでの管理を希望されるクライアント様も多いため、少しでも作成が楽になるWorkflowテンプレートも公開しております。
https://github.com/tsukaharakazuki/td/tree/master/create_table_definition

こちらは、トレジャーデータが用意しているinformation_schemaを用いて、内部のMeta情報にアクセスし、SQLでテーブル定義書に必要な情報を作成し、Googleスプレッドシートに出力するところまでがテンプレート化されています。スプレッドシートに出力されてからの、整形や、更新日付処理などは手動（もしくはマクロを組む）など対応していただく必要はありますが、以下のようなサンプルレコードなども追記されたデータを簡単に出力することが可能です。

こちらのWorkflowはテーブルごとにカラムが異なるため、Workflowの設定はお客様それぞれでカラムの説明やサンプルデータの記述はしていただく必要があります。
ご不明点あれば、担当までお問い合わせください。