テーブルにコメントを設定(comment on table)

comment on table

SQL コマンド comment on table で、テーブルの用途や定義情報など任意のコメントを
データディクショナリの user_tab_comments テーブルへ保存できる。
(comments 列のデータ型は varchar2 なので、最大4,000バイトまで)

テーブル定義

SQL> desc user_tab_comments

 名前         NULL?    型
 ---------- -------- ----------------
 TABLE_NAME NOT NULL VARCHAR2(30)
 TABLE_TYPE          VARCHAR2(11)
 COMMENTS            VARCHAR2(4000)

コメントを設定するSQLコマンド

comment on table ＜テーブル名＞ is 'コメント内容';

(1) HOGE テーブルの事前状態を確認

SQL> select * from user_tab_comments where table_name = 'HOGE';

レコードが選択されませんでした。

(2) コメントを設定

SQL> comment on table HOGE is 'コメントテスト';

コメントが作成されました。

(3) HOGE テーブルの事後状態を確認

SQL> select * from user_tab_comments where table_name = 'HOGE';

TABLE_NAME TABLE_TYPE COMMENTS
---------- ---------- --------------
HOGE       TABLE      コメントテスト