tblsはいいぞ（第44回 PostgreSQLアンカンファレンス@オンライン）

Transcript

1. tblsはいいぞ 第44回 PostgreSQLアンカンファレンス @オンライン
2. この間のPostgreSQLConference Japan 2023が 初参加でとても楽しかったので勢いで LTさせていただいています 社外のLTは初めてなので暖かい目で見ていただけると幸いです お名前：まじまっちょ X（旧Twitter）：@majimaccho_ お仕事：医療系未上場企業のアプリケーションエンジニア 好きなもの：美味しいお酒とお肉 自己紹介
3. tblsはいいぞ🦍
4. tblsとは • 既存のDBスキーマ、テーブルコメント、カラムコメントからDBのドキュメントを生成 • Markdown形式なのでGitHubから参照でき、ホスティングが不要 • カラムコメント、テーブルコメントの有無などを検証 • CIへの組み込みが容易 https://speakerdeck.com/k1low/phpconfuk-2023?slide=7
5. プチアピール ちょっとだけ私もコントリビュートしてます
6. なんのためにDBのドキュメンテーションを行うか • 再来月の全て忘れた自分が思い出すため
 • 開発チームに新規参加したメンバーがキャッチアップするため
 • 運用チームがSQLでDBにアクセスしてトラブルシュートするため
 • 解析チーム、データ基盤チームが既存のDBの内容を理解するため 釈迦に説法すぎてすいません…
7. よくあるDBドキュメンテーションの課題 • メンテナンスされない
 • 存在が知られていない
 • ER図が大きすぎて読めない
 • そもそも存在しない
8. tblsによって生成されるドキュメント
9. tblsによって生成されるドキュメント • トップのドキュメント（全体像） ◦ Viewpoints（後述） ◦ テーブル一覧（テーブルコメント） ◦ ER図 • テーブル詳細 ◦ 概要（テーブルコメント） 
 ◦ カラム一覧（カラムコメント） 
 ◦ Viewpoints（後述） 
 ◦ 制約一覧
 ◦ インデックス一覧 
 ◦ ER図
 • Viewpoint詳細（後述） ◦ 概要
 ◦ 内包するテーブルの一覧 
 ◦ 内包するテーブルのER図
10. Viewpointはいいぞ🦍
11. Viewpoint(s)とは • tbls独自の概念
 • DBのスキーマを任意のまとまりに分割
 • DDLでの設定ではなく、tblsの設定ファイルのYAMLに記述 https://speakerdeck.com/k1low/phpconfuk-2023?slide=34
12. Viewpointがあると - トップのドキュメント • 全体像を表すトップのドキュメント にViewpointの一覧がくる
 • ここでデータの種類・利用のされ方 の概要が掴める
 • 名前がViewpointのリンクになって いて個別のViewpointの内容に飛 べる

13. Viewpointがあると - Viewpoint詳細 • データのまとまりごとにテー ブル一覧が見られる
 • 意味的なまとまりの範囲を 伝えられる
 • ER図がViewpointの単位に できて見やすい

14. • 個別のテーブルがどの Viewpointから参照されている のかわかる
 • Viewpoint⇔個別のテーブルを 行来するとDB設計の理解が進 む
 Viewpointがあると - テーブル詳細
15. Viewpointの設定の仕方 キー 説明 name Viewpointの名前 desc Viewpointの説明 tables Viewpointに含まれるテーブ ルの一覧
16. • requireColumnComment（カラムコメントの必須化） ◦ カラムコメントが設定されていないカラムがあるとリントエラーになります。 ◦ どのカラムに設定されていないかを出力してくれます。 ◦ オプションでid, created_atなど任意の名前のカラムを対象外にできます。 • requireTableComment (テーブルコメント必須化) ◦ requireColumnCommentのテーブルコメント版です。 ◦ テーブルコメントが設定されていないテーブルがあるとリントエラーになります。 • requireViewpoints (Viewpoints必須化) ◦ 一つもViewpointに属していないテーブルがあるとリントエラーになります。 tblsのリント機能
17. PostgreSQLならViewもマテビューも見やすく！ Viewもマテビューも テーブルとして扱われ るが、タイプから見分 けられる Viewpointに含めて関 連するデータと一緒に ドキュメンテーションで きる
18. PostgreSQLならViewもマテビューも見やすく！ 詳細からはViewとマテビューは作成時の SQLが参照できる！ 参照しているテーブルも一覧が出る！ すいません…勢い駆動LTにつき、ポスグレ関係で 何かないかと思って無理やりここを足しました。 🐘
19. おまけ
20. 実際に見てみよう https://github.com/majimaccho/prisma-tbls
21. 今日の内容をもう少し詳しく書いたのでよろしければ見てやってください DBスキーマはtblsのViewpointsで整理しよう