PostgreSQL テーブルにコメント追加する

PostgreSQL テーブルにコメント追加する

PostgreSQLで、テーブルにコメント追加する手順を記述してます。

環境

  • OS Rocky Linux release 8.4 (Green Obsidian)
  • PostgreSQL 14.0
  • pgadmin 6.0

テーブルにコメント追加

テーブルにコメント追加したい場合は、「COMMENT ON TABLE」を使用します。

COMMENT ON TABLE テーブル名 IS 'コメントを記述'

実際に「testTable」というテーブルにコメントを追加してみます。

COMMENT ON TABLE testTable IS 'コメント追加'

実行結果

追加したコメントを確認してみます。

select
  pg_class.relname, 
  pg_description.description 
from
  pg_class 
  left outer join pg_description 
    on pg_class.oid = pg_description.objoid 
    and pg_description.objsubid = 0
where pg_class.relname = 'testtable'

コメントが追加されていることが確認できます。

コメント削除

コメントを削除する場合は、「null」を挿入します。

COMMENT ON TABLE testTable IS NULL