スキーマ変更時は、関連するデータの設計と実装を行うので問題ないのですが、規模が大きくなったり、新しい人が入ってくるような環境だと各テーブルやカラムに保存されるデータがどんなものかわからなくなりがちです

Excel や esa などのドキュメントで管理をすると、それを変更しないと本番の DB に反映されないなどの運用フローがないとほぼ確実にメンテされなくなります

結果として、ほぼ確実に今現在動いているスキーマに関する情報が足りなかったり、古くなります

そこで弊社ではテーブルとカラムに何を表すテーブル・カラムかコメントを残すようにしています

また、自分の会社ではデータドリブンを価値観として掲げているので、非エンジニアもデータが触れるような環境を Redash を用いて作っています

非エンジニアもデータを触れる環境を作ろうとしているので、Redash で各テーブルのコメントを見れるようにしました

クエリ

-- テーブル一覧の表示SHOW TABLES;

-- テーブル名とコメントの表示SELECT  TABLE_NAME AS `テーブル名`,  TABLE_COMMENT AS `テーブル詳細`FROM INFORMATION_SCHEMA.TABLESWHERE TABLE_SCHEMA = 'sample'

-- カラム名と型、コメントの表示SELECT  t.COLUMN_NAME AS `カラム名`,  t.DATA_TYPE AS `データ型`,  t.COLUMN_COMMENT AS `カラム詳細`FROM (    SELECT * FROM INFORMATION_SCHEMA.COLUMNS    WHERE TABLE_NAME = '{{table}}') t

SHOW TABLES や SHOW FULL COLUMNS FROM [TABLE NAME] で表示することが可能だが、必要なカラムだけ表示するようにしている

これで非エンジニアもテーブルの詳細について見れるようになったと