質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.47%

  • データベース

    719questions

    データベースとは、データの集合体を指します。また、そのデータの集合体の共用を可能にするシステムの意味を含めます

  • ドキュメント

    20questions

    ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

DBのテーブルやビューの役割、構成、制約をまとめるドキュメントってどうやって作りますか?

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 1,419

usugita_san

score 219

MySQLを使用したシステム開発を行っています。

各テーブルの役割、データ型や制約、カラムの役割、コードの意味などをまとめたドキュメントを必要としています。

今まではERMasterからエクスポートしたExcelファイルを使用していました。コメントに色々情報を書き込んでいました。しかしいくつか問題が発生しています。

  • SQLでコメントを書かないといけない。
ERMasterはテーブルの構成を読み取ってExcelにまとめています。なのでテーブルやカラムの説明を記述したい場合、SQLのコメントに書くしかありません。編集がとても面倒です。
  • 教育が面倒
私の職場ではEclipseを使用していません。しかしERMasterを使うためにEclipseをわざわざ用意し、プラグインのインストールが必要です。新人に教えるのにも割りと面倒です。
  • 他DBを使用したViewを読み取れない。
これが一番困るんですが、ERMasterは複数のDBに依存するViewをドキュメント化すると例外が発生するようです。

というわけで、ERMasterは大変便利なのですが、他の方法に移行しようと思っています。
名前が解らないのですが、多分テーブル設計書とかDB設計書になると思います。

こういったドキュメントは、皆さんはどうやって作っていますか?
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

私は「A5:sql mk-2」というツールをよく使います。
DB接続してしまえば、テーブル定義などを出力できるので、
あとは必要な情報を出力したものに足していく感じですかね。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/04/29 10:42

    ありがとうございます。一旦このツールを使ってみようと思います。
    これならEclipseも必要ないし、便利そうですね。

    キャンセル

  • 2015/05/13 13:44

    このツールから出力したドキュメントを使用する事にしました。
    ありがとうございました。

    キャンセル

関連した質問

  • 解決済

    h2Databaseはeclipseからつかうものですか?それともウェブ上から使うものでしょうか?

    h2Databaseはeclipseからつかうものですか?それともウェブ上から使うものでしょうか?一度開いたウェブのページを開けなくなってしまい迷っています。よろしくお願いします。

  • 解決済

    O/RマッパーDomaの設定方法

    参考HP 参考HPのセットアップの確認というところでつまづいています。 プロジェクト直下の「.apt_generated」というディレクトリに保存されます。とあるのですが そ

  • 解決済

    java アノテーション

    javaを触り始めたばかりなのですが、アノテーション?というものがどういうものなのがさっぱりわかりません… 注釈といった意味があるようなのですが、コメントとはどう違うんでしょうか

  • 解決済

    Excel 英語から日本語に変換 単なるローマ字変換ではない

    A1にAppleと入力したら、B1にりんご若しくはアップルと表示させたいのですが、何か方法はないでしょうか? 入力する英語は不特定多数なので別シートで対応づけることはしたくあ

  • 解決済

    Eclipseで文字化けです。

    Eclipseで取ってきたデータベースの日本語が文字化けします。 データベースはMySQLを使用しており、.cnfというファイルも見つからず、unicodeを追加しても何ら変わ

  • 解決済

    Excel VBA 特定範囲の重複している列に空白を設定する

    お世話になっております EXCELのVBAや関数を使用し、下記の様な表を編集したいと思っております。 置換前 グループ 項目1* 項目2 項目3 項目X 項目Y

  • 解決済

    【ExcelVBA】テキストフォーマットの変数書き方

    前提・実現したいこと 設定シート(Eecelシート)から値を取得し、SQL作成するExcelマクロを作成しています。 設定シートから取得する部分を変数に格納し、テキストファイルのテ

  • 解決済

    VBAマクロ 置き換えループが空振りしてしまう

    前提・実現したいこと こちらで何度か質問させていただき設定シートとテキストのSQLフォーマットを読み込み、SQLを大量作成する マクロを作成しています。全部で100テーブル以上を対

同じタグがついた質問を見る

  • データベース

    719questions

    データベースとは、データの集合体を指します。また、そのデータの集合体の共用を可能にするシステムの意味を含めます

  • ドキュメント

    20questions

    ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。