PostgreSQL | PostgreSQL 基本構文 | コメント(comment)を書く

Tags:

• PostgreSQL
• Database

PostgreSQL で SQL を書くときにコメントを記述する方法について説明する。

コメントを書く方法

SQL 文を書くとき、コメントを書きたい場合はハイフンを 2 つ続けて記述する (--)。その位置から行末までがコメントになる。

-- 1 行がコメントである。

また、複数行のコメントを書くには、/* から */ までの部分をコメントにする。

/* ここからコメントである。
複数行のコメントが可能である。
*/

コメントは実行時に完全に無視されるため、psql をコマンドラインで使用して SQL コマンドを実行する場合、コメント部分には意味がない。ただし、SQL コマンドを別ファイルに書いておき、そのファイルを読み込んで実行する場合などに使用できる。

実際に試してみる。テキストエディタを開き、次のように記述する。

/*
テーブル作成およびデータ追加
2020/10/26
*/

-- テーブル作成
create table friends (id integer, name varchar (10));

-- データ追加
insert into friends values (1, 'kimkc');
insert into friends values (2, 'hwang.yh');
insert into friends values (5, 'lim.yt');

作成したファイルを、今回は test.sql という名前で c:\dev ディレクトリに保存する。

現在の psql の文字コードを確認すると UHC になっているため、ファイルの文字コードは EUC_KR で保存する。

postgres=# \encoding
UHC
postgres=#

それでは、psql を使用して PostgreSQL の mydb データベースに接続する。

C:\Users\kimkc>psql -U postgres -d mydb
postgres ユーザーのパスワード:
psql (12.2)
ヘルプを表示するには "help" と入力してください。

mydb=#

保存したファイルを読み込んで実行するには、psql コマンドの \i を使用して次のように実行する。

mydb=# \i c:/dev/test.sql
CREATE TABLE
INSERT 0 1
INSERT 0 1
INSERT 0 1
mydb=#

ファイルに書いたコメント部分は無視され、それ以外の部分が正常に実行された。確認のため、psql で次のように SQL コマンドを実行してみる。

mydb=# select * from friends;
 id |   name
----+----------
  1 | kimkc
  2 | hwang.yh
  5 | lim.yt
(3 行)

テーブルが作成され、データが 3 件追加されていることを確認できる。

–

ここまで、PostgreSQL でコメントを書く方法について説明した。