データベースのドキュメント管理を自動化した話 - estie inside blog

こんにちは、今回はデータ基盤構築を担当しているmarushoがお送りします。 今日はestieで実践しているデータベースのドキュメント管理方法をご紹介します。 はじめに 独自成長していくデータベースたち 失われたドキュメント どうすれば低コストなドキュメント管理ができるのか そして生まれた、schema collectorという自動化ツール SchemaSpy Mysql diff Priv Page ECS タスクスケジューラ ドキュメントを腐らせない おわりに はじめに estieはオフィスを中心とした不動産データを取り扱うスタートアップ企業です。 estie（オフィス探しサービス）とestie pro（不動産事業者向けデータプラットフォーム）の2つのサービスを運営しています。 詳しくは、こちらの記事をご覧ください。 inside.estie.co.jp estieでは、不動産に関する

[fukken]

データの流れが逆じゃね。DB更新を、Git管理のスキーマファイルからしかやってはいけないルールにすればいい。理由などを含めたPRが常に見られる。

[auient]

自動生成ドキュメントと手で魂込めた資料のうまい統合方法をぼくらはまだ知らない

[michael-unltd]

SchemaSpy

[diveintounlimit]

うーん、運用フローを改善するんじゃなくて運用フロー上の問題を見えないように蓋をしているように見える/gh-ost, skeefree,skeemaといったツールを紹介しておく

[tune]

カラムやテーブルにコメントを入れる運用の方が参考になる情報があって良いなと個人的には感じています。

[mytechnote]

“よう 出力したスキーマファイルを社内で共有できるようにしたいよね => リポジトリにpushしちゃえばGithub Pagesで閲覧できそう 自動化して常に最新に保ちたいよね”

[iwtn]

よさそう

[khtno73]

万一の時見られるのが要なので参照頻度低くてもコストかけて網羅すべきってのは悩み。その点スキーマ変更記録自動化は良いが何のために表・列が追加されどんな値を取る？をアプリの変更履歴と紐付けまで制度化したい

[iww]

差分が出たら担当にメールと更新催促の電話を自動でしてくれるなら便利そうだけど、

[Nfm4yxnW8]

"共通データベースと一部同期"レプリケーションという意味?"プロダクトごとに必要なカラムを追加"ってのを見るとレプリケーションではなくスキーマの共有か?なぜスキーマの共有が必要なんだろうと色々疑問になった