PostgreSQLでテーブルやカラムにコメントを設定する方法

PostgreSQLではテーブルやカラムにコメントを設定することができます。

コメントを設定しておくことで、各テーブルやカラムの意味を明確に残しておくことができます。

今回はPostgreSQLでテーブルやカラムにコメントをSQLを使って設定する方法を解説します。

ちなみにテーブルコメントをSQLで取得するにはこちらの記事を参照してください。

PostgreSQLでテーブルコメントの設定

PostgreSQLでテーブルにコメントをSQLで設定するには「COMMENT」コマンドを使用します。

テーブルにコメントを設定する「COMMENT」コマンドの書式は以下の通りです。

COMMENT ON TABLE ＜設定するテーブル名＞ IS '設定するコメント'

実際のテーブルにコメントを設定するには以下のようなコマンドを実行します。

COMMENT ON TABLE test_table IS 'これはテストテーブルのコメントです。'

これでテーブルにコメントを設定することができます。

また、テーブルコメントを削除する場合はコメントにNULLを設定してCOMMENTコマンドを実行します。

COMMENT ON TABLE test_table IS NULL

PostgreSQLでカラムにコメントをSQLで設定する場合も「COMMENT」コマンドを使用します。

カラムにコメントを設定する「COMMENT」コマンドの書式は以下の通りです。

COMMENT ON COLUMN ＜設定するテーブル名＞.＜設定するカラム名＞ IS '設定するコメント'

実際のテーブルにコメントを設定するには以下のようなコマンドを実行します。

COMMENT ON COLUMN test_table.test_column IS '設定するコメント'

これでカラムにコメントを設定することができます。

また、カラムコメントを削除する場合はコメントにNULLを設定してCOMMENTコマンドを実行します。

COMMENT ON COLUMN test_table.test_colum IS NULL

PostgreSQLでテーブルやカラムにSQLでコメントを設定するには「COMMENT」コマンドを利用します。

どちらの場合もコメントを削除する場合は設定する値にNULLを設定することで削除することができます。

SQLServerの場合は以下の記事を参照してください。