postgresql表和列註釋（描述）

PostgreSQL添加表和列註釋。本文爲測試表test，默認無註釋。

test=# \d+
                       關聯列表
 架構模式 | 名稱 |  類型  |  擁有者  |  大小   | 描述
----------+------+--------+----------+---------+------
 public   | test | 數據表 | postgres | 0 bytes |
(1 行記錄)

test=# comment on table test is '測試表';
COMMENT
test=# \d+
                        關聯列表
 架構模式 | 名稱 |  類型  |  擁有者  |  大小   |  描述
----------+------+--------+----------+---------+--------
 public   | test | 數據表 | postgres | 0 bytes | 測試表
(1 行記錄)

test=#

下面演示添加列註釋。

test=# alter table test add column id int primary key;
ALTER TABLE
test=# alter table test add column name text not null;
ALTER TABLE
test=# alter table test add column sex boolean default true;
ALTER TABLE
test=# comment on column test.id is 'ID表';
COMMENT
test=# \d+
                         關聯列表
 架構模式 | 名稱 |  類型  |  擁有者  |    大小    |  描述
----------+------+--------+----------+------------+--------
 public   | test | 數據表 | postgres | 8192 bytes | 測試表
(1 行記錄)

test=# \d+ test
                             數據表 "public.test"
 欄位 |  類型   | Collation | Nullable | Default |   存儲   | 統計目標 | 描述
------+---------+-----------+----------+---------+----------+----------+------
 id   | integer |           | not null |         | plain    |          | ID表
 name | text    |           | not null |         | extended |          |
 sex  | boolean |           |          | true    | plain    |          |
索引：
    "test_pkey" PRIMARY KEY, btree (id)

test=#

刪除表和列註釋只須要將註釋信息設置爲空便可。也可使用IS NULL命令。

test=# comment on column test.id is '';
COMMENT
test=# comment on table test is '';
COMMENT
test=# \d
              關聯列表
 架構模式 | 名稱 |  類型  |  擁有者
----------+------+--------+----------
 public   | test | 數據表 | postgres
(1 行記錄)

test=# \d+
                        關聯列表
 架構模式 | 名稱 |  類型  |  擁有者  |    大小    | 描述
----------+------+--------+----------+------------+------
 public   | test | 數據表 | postgres | 8192 bytes |
(1 行記錄)

test=# \d+ test
                             數據表 "public.test"
 欄位 |  類型   | Collation | Nullable | Default |   存儲   | 統計目標 | 描述
------+---------+-----------+----------+---------+----------+----------+------
 id   | integer |           | not null |         | plain    |          |
 name | text    |           | not null |         | extended |          |
 sex  | boolean |           |          | true    | plain    |          |
索引：
    "test_pkey" PRIMARY KEY, btree (id)

test=#
#IS NULL 練習
test=# comment on column test.id is 'ID信息';
COMMENT
test=# comment on table test is '測試信息';
COMMENT
test=# \d+
                          關聯列表
 架構模式 | 名稱 |  類型  |  擁有者  |    大小    |   描述
----------+------+--------+----------+------------+----------
 public   | test | 數據表 | postgres | 8192 bytes | 測試信息
(1 行記錄)

test=# \d+ test
                              數據表 "public.test"
 欄位 |  類型   | Collation | Nullable | Default |   存儲   | 統計目標 |  描述
------+---------+-----------+----------+---------+----------+----------+--------
 id   | integer |           | not null |         | plain    |          | ID信息
 name | text    |           | not null |         | extended |          |
 sex  | boolean |           |          | true    | plain    |          |
索引：
    "test_pkey" PRIMARY KEY, btree (id)

test=# comment on column test.id is null;
COMMENT
test=# comment on table test is null;
COMMENT
test=#

參考連接

http://www.postgres.cn/docs/9.6/sql-comment.html

https://www.postgresql.org/docs/current/static/sql-comment.html