抽出条件のドキュメント

質問

データベースからデータを抽出する条件をドキュメント（文書）に書くとき、どんな書き方がよいですか。

使用するテーブル名、結合条件、抽出条件、ソート条件、group by句などを一覧表に書きたいのです。

わかりやすく誤解が生じにくいことが望ましいのですが、どうやって書いたらいいか毎度悩んでしまいます。特に複数のテーブルを結合する場合は書き方がむずかしく、いつも困っています。

何かよいお手本はないでしょうか。

回答No.1

rivoisu · ベストアンサー

なかなかレスがつきませんね。
皆それぞれにやっていることはあるのでしょうが、それが正解という自信が無いのでしょう。
あなたの状況に合うかどうか分かりませんが私のやり方を書きます。
通常DB設計時にテーブル仕様書を書きます。
このフォーマットを少し変更して見出し部にSQL文の名称などを見出し部の注釈に、使用テーブル、抽出条件、結合条件、ソートキーなどを書きます。
明細部に項目名、タイプ、主キーかどうかを書きます。この摘要欄に元のテーブル、関数などを書きます。
つまり、sum(A) as B　は項目名がBで摘要欄にsum(A)と書きます。groupキーもここに書きます。
たまにこれでは記述しにくいこともありますがそれは最後のほうで書いておきます。
私は速度にシビアな時以外はあまり複雑なSQLは使わずコードの中で処理してますので今のところこれで足りています。
参考になれば。

お礼

レスありがとうございす。
なかなか反応がなくて、あきらめかけておりました。

社内で標準になるようなマトリクス的なもの（非IT系の人にも理解してもらえるような）を想定していたのですが、やはり「これがスタンダードだ！」という書き方はないのでしょうね。テンプレートみたいなものがあると助かるなあと思っていましたが。

rivoisuさんのおっしゃるように、テーブル設計書をベースに抽出条件欄、結合条件欄、ソートキー欄、groupキー欄などを設けることにします。

その際、もしテーブルだけでなくビューに対する結合がある場合は、そのビューについてのドキュメントは別紙に分けた方がわかりやすいでしょうか？

それから、データベースを中心にした詳細設計の書き方についてのよい本などありましたら紹介していただけるとうれしいです。