PolarDB Oracle 互換スキーマオブジェクトへのコメント追加 - PolarDB - Alibaba Cloud - PolarDB

テーブルまたは列にコメントを追加または更新します。

構文

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

COMMENT ON は、データベースオブジェクトにテキスト形式のコメントを格納します。各オブジェクトには最大で 1 つのコメント文字列のみ保持可能であり、同一オブジェクトに対して新しい COMMENT ON を実行すると、既存のコメントが置き換えられます。

コメントを削除するには、text を空文字列（連続する 2 つのシングルクォート： ''）に設定します。また、対象のオブジェクトが削除されると、そのオブジェクトに付与されたコメントも自動的に削除されます。

コメントにはアクセス制御が適用されません。データベースに接続しているすべてのユーザーが、すべてのオブジェクトに付与されたコメントを読み取ることができます。機密情報をコメント内に格納しないでください。

パラメーター	説明
`table_name`	コメントを付与するテーブルの名前です。スキーマ修飾が可能です。
`table_name.column_name`	`table.column` 形式で指定する、コメントを付与する列の名前です。テーブル名はスキーマ修飾が可能です。
`text`	コメントの本文です。既存のコメントを削除する場合は、空文字列（`''`）を指定します。

COMMENT ON TABLE emp IS '現在の従業員情報';
COMMENT ON COLUMN emp.empno IS '従業員識別番号';

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

emp テーブルのコメントおよびメタデータを表示します：

\dt+ emp

emp テーブル内のすべての列に関するコメントを表示します：

\d+ emp