使用COMMENT為表或列定義或更改注釋-雲原生資料庫 PolarDB-阿里雲

定義或更改對象的注釋。

文法

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

COMMENT 儲存有關資料庫物件的注釋。要修改注釋，請為同一個對象發布新的 COMMENT 命令。只能為每個Object Storage Service一個注釋字串。要刪除注釋，請為 text 指定Null 字元串（兩個連續的單引號，中間沒有空格）。刪除對象時將自動刪除注釋。

說明當前沒有針對注釋的安全機制：串連到資料庫的任何使用者都可以查看該資料庫中對象的所有注釋。不要在注釋中放置重要的安全資訊。

參數	說明
table_name	要加註釋的表的名稱。表名可能是 schema 限定的。
table_name.column_name	要加註釋的 table_name 中的列的名稱。表名可能是 schema 限定的。
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 '';

查看emp表的注釋：

\dt+ emp;

查看emp表中的列的注釋：

\d+ emp;