オブジェクトのコメントを定義または変更します。

構文

COMMENT ON
{
  TABLE table_name |
  COLUMN table_name.column_name
} IS 'text'

説明

COMMENT コマンドを使ってデータベースオブジェクトについてのコメントを保存します。 オブジェクトのコメントを変更するためには、そのオブジェクトに対して新しい COMMENT コマンドを発行する必要があります。 オブジェクトごとに保存できるコメント文字列は 1 つです。 コメントを削除するためには、テキストパラメーターに対して空の文字列 (スペースを含まない連続した単一引用符 2 つ) を指定します。 オブジェクトが削除されるとコメントも自動的に削除されます。

現在、コメントに対するセキュリティメカニズムはありません。 データベースへ接続するすべてのユーザーがそのデータベースにあるオブジェクトのコメントを表示することができます。 重要なセキュリティ情報をコメントに入れないでください。

パラメーター

パラメーター 説明
table_name コメントを入力するテーブルの名前。 テーブル名はスキーマ修飾することができます。
table_name.column_name テーブルでコメントする列の名前。 テーブル名はスキーマ修飾することができます。
text 新しいコメント。

emp という名前のテーブルにコメントを添付します。

COMMENT ON TABLE emp IS 'Current employee information';

emp テーブルの empno 列にコメントを添付します。

COMMENT ON COLUMN emp.empno IS 'Employee identification number';

コメントを削除します。

COMMENT ON TABLE emp IS '';
COMMENT ON COLUMN emp.empno IS '';