コメントを記述する

PostgreSQL では SQL を記述する時にコメントを残しておくことができます。ここでは PostgreSQL でコメントを記述する方法について解説します。

(Last modified: 2023年01月07日)

コメントの記述方法

SQL 文を記述するときにコメントを記述したい場合には、ハイフンを二つ続けて記述( -- )したところから文の最後までがコメントとなります。

また 複数行にわたるコメントを記述する場合は /* から */ までの部分がすべてコメントとなります。

コメントは実行時には完全に無視されるので、例えば psql を使ってコマンドラインベースで SQL コマンドを実行している時にコメントを記述しても何も意味がありませんが、例えば別のファイルに SQL コマンドを記述しておき、ファイルを読み込んで実行する場合などに利用できます。

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

/*
テーブルの作成とデータの追加
2019/05/18
*/

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

-- データの追加
insert into friends values (1, 'Yamada');
insert into friends values (2, 'Endou');
insert into friends values (5, 'Nakata');

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

ファイルの文字コードですが、現在 psql の文字コードを確認すると SJIS となっていますので、ファイルも Shift_JIS で保存しました。

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

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

ファイルに記載したコメントの部分は無視されてそれ以外の部分が正常に実行されました。確認のために psql から次のように SQL コマンドを実行してみます。

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

-- --

PostgreSQL でコメントを記述する方法について解説しました。

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。