広告
あやせツールズ_ロード

DB論理名コメントSQL生成ツール

テーブル・カラムの物理名と論理名からコメント追加SQLを生成
PostgreSQL / Oracle / SQL Server / MySQL・MariaDB / DB2 / SQLite対応
DB・テーブル設定
MySQL / MariaDB はカラムコメント変更時に型定義が必要です。
カラム設定
CSV / TSV / 改行区切りに対応。1列目=物理カラム名、2列目=論理カラム名、3列目=MySQL・MariaDB用の型定義です。
行番号で対応します。左の1行目と右の1行目、左の2行目と右の2行目、という形で組み合わせます。 MySQL・MariaDBでカラムコメントも生成する場合は、型定義が必要なため「一覧入力」を使ってください。
生成SQL

DBの論理名コメントSQLを生成する無料ツール

このページでは、テーブル物理名、テーブル論理名、カラム物理名、カラム論理名を入力して、DBコメントや拡張プロパティを追加するSQLを生成できます。設計書やカラム一覧から、各DB向けのコメント追加SQLをまとめて作りたいときに便利です。

SQL生成はブラウザ上のJavaScriptで実行されます。入力したテーブル名やカラム名をサーバーへ送信せず、手元の画面だけでSQLを作成できます。

使い方

  1. 対象DBを選び、スキーマ名、テーブル物理名、テーブル論理名を入力します。
  2. カラム一覧に、物理カラム名、論理カラム名、必要に応じて型定義を入力します。
  3. または「物理名・論理名を分けて入力」タブで、左右の行番号を対応させて入力します。
  4. 出力したい対象に合わせて、テーブル論理名、カラム論理名、トランザクションの有無を選びます。
  5. 生成SQLを確認し、問題なければコピーしてDB管理ツールやマイグレーション作成に利用します。

対応しているDB

DB 生成する主なSQL 補足
PostgreSQL COMMENT ON TABLE / COMMENT ON COLUMN スキーマ名を指定して生成できます。
Oracle COMMENT ON TABLE / COMMENT ON COLUMN Oracle標準のコメント構文で出力します。
SQL Server sys.sp_addextendedproperty MS_Descriptionとして拡張プロパティを追加します。
MySQL / MariaDB ALTER TABLE ... COMMENT / MODIFY COLUMN カラムコメントには型定義が必要です。
DB2 COMMENT ON TABLE / COMMENT ON COLUMN DB2のコメント構文で出力します。
SQLite メタデータ管理テーブル用の参考SQL SQLiteには標準のコメントDDLがないため、参考用SQLを生成します。

入力形式の例

「一覧入力」では、1行に物理名、論理名、型定義をカンマまたはタブ区切りで入力できます。MySQL / MariaDBでカラムコメントを生成する場合は、既存の型定義を含める必要があります。

入力例 意味
customer_id,顧客ID,BIGINT NOT NULL 物理名:customer_id、論理名:顧客ID、MySQL用型定義:BIGINT NOT NULL
customer_name,顧客名,VARCHAR(100) 物理名:customer_name、論理名:顧客名、MySQL用型定義:VARCHAR(100)

活用例

  • ER図やテーブル定義書から、DBコメント追加SQLをまとめて作成する。
  • 既存DBへ論理名を後付けし、DB管理ツール上で項目の意味を確認しやすくする。
  • PostgreSQL、Oracle、SQL Serverなど、DBごとに異なるコメント構文を切り替えて生成する。
  • マイグレーションファイルやリリース作業用SQLの下書きを作る。

利用時の注意点

  • 生成SQLは実行前に必ず対象DB、スキーマ名、テーブル名、カラム名を確認してください。
  • MySQL / MariaDBのMODIFY COLUMNは型定義、NULL制約、DEFAULT、AUTO_INCREMENTなどを誤ると既存定義に影響する可能性があります。
  • SQL Serverで既に同名の拡張プロパティが存在する場合、環境によっては追加ではなく更新用SQLが必要になる場合があります。
  • 識別子を引用符で囲む場合、大文字小文字の扱いがDBごとに変わることがあります。
  • 本番DBへ適用する前に、検証環境で実行結果を確認してください。