COMMENT

Name

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

Synopsis

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

Description

COMMENT には、データベースオブジェクトに関するコメントが格納されます。コメントを変更するには、同じオブジェクトに対して新しい COMMENT コマンドを発行します。オブジェクトごとに1つのコメント文字列のみが保存されます。コメントを削除するには、 text に空の文字列（スペースを入れずに2つの連続した単一引用符）を指定します。オブジェクトがドロップされると、コメントは自動的にドロップされます。

Parameters

table_name

コメントするテーブルの名前。テーブル名はスキーマ修飾することができます。

table_name.column_name

コメントする table_name 内の列の名前。テーブル名はスキーマ修飾することができます。

text

新しいコメント。

Notes

現在、コメントに対するセキュリティメカニズムはありません。データベースに接続しているユーザーは、そのデータベース内のオブジェクトのすべてのコメントを見ることができます（ただし、所有していないオブジェクトのコメントを変更できるのはスーパーユーザーのみです）。 Do not put security-critical information in a comment 。

Examples

テーブルにコメントを添付します 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 '';