【PostgreSQL】メタコマンド〜\echo〜

初めに

Qiita Engineer Festa 2024に参加中。完走目指してます。
他のメタコマンドについては以下から読んでください。

\echoとは

評価された引数を空白で区切り、標準出力に出力し、改行します。 スクリプトが出力するところどころに情報を記載する場合に有用です。 使用例を次に示します。

=>\echo `date`
Tue Oct 26 21:40:57 CEST 1999

最初の引数が引用符で囲まれていない-nである場合、最後の改行は出力されません(し、最初の引数も出力されません)。

\echoについて

試してみた

echo.sqlとして以下を記載する。

\set name 'daichi'
\echo 'Starting script execution...'
\echo 'Hello, ' :name!
\echo 'Querying the database:'
SELECT count(*) FROM users;
\echo 'Script execution completed.'

実行してみる。

psql -f echo.sql

Starting script execution...
Hello,  daichi!
Querying the database:
 count 
-------
     4
(1 row)

Script execution completed.

まとめ

スクリプトを組んだ際に今何をしているのかをわかるように使うのが良さそう。
あとは失敗したエラー文として出力するのも良い。