[PostgreSQL] 知らないと損!コメントに関するtips3つ

PostgreSQL Advent Calendar 25日目です。

/* ~ */ で複数行にわたるコメント

SQLでコメントを書くとき、"--"を使うのはよく知られています。

-- ここはコメントです。
-- ここもコメントです。

知らない人が結構いるのですが、/* ~ */ でブロックコメントを書くことができます。

こちらのスタイルの方が、C/Java/Javascript/PHP と同じなのでプログラマに優しいと思います。
これは標準SQL準拠です。

/*
 ここはコメント
 ここもコメント
 ここまでコメント 
*/

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

CREATE TABLEするときに、一緒にコメントを設定しておくとハッピーになれます。

COMMENT ON TABLE  members IS '会員テーブル';
COMMENT ON COLUMN members.id IS '会員ID';

コメントでは改行コードを含めることができます。
これを使うと、説明的な長いコメントを書くことができます。
ドキュメントをエクセルで残すよりも実用的なのでオススメです。

COMMENT ON TABLE members  IS E'会員テーブル\n会員情報を格納するテーブルです。\n使い方はほげほげで、ふがふがに注意してください';

テーブルやカラムのコメントを見る

設定したコメントは、phpPgAdminやpgAdmin等で閲覧できます。

psqlで見るときは下記のようにします。

カラムのコメントを見る
mydb=> \d+ members
       テーブル "public.members"
 カラム | 型      |  修飾語  | ストレージ | 説明
--------+---------+----------+------------+------------
 id     | integer | not null | plain      | 会員ID

テーブルのコメントを見る
mydb=> \dt+ members
                         リレーションの一覧
 スキーマ |    名前     |    型    |  所有者  | サイズ |    説明
----------+-------------+----------+----------+--------+------------
 public   | members     | テーブル | dqneo    | 16 kB  | 会員テーブル
                                                       : 会員情報を格納するテーブルです。
                                                       : 使い方はほげほげで、

おわりに

こんな入門記事でPostgreSQL Advent Calendar2011のオオトリをしめくくってしまいました。。
でもPostgreSQLの裾野を広げるには初心者対策が一番重要だと思います。

メリークリスマス!!
カテゴリ: