pg_isreadyでPostgreSQLの接続状態を確認する

pg_isreadyでPostgreSQLの接続状態を確認する

pg_isreadyコマンドを使用して、PostgreSQLの接続状態を確認する手順を記述してます。

環境

  • OS  ubuntu20.10
  • PostgreSQL 13.1

pg_isready使い方

pg_isreadyコマンドを利用すれば、サーバーとの接続状態を確認することが可能です。

pg_isready

<オプション>
-d dbname --dbname=dbname
接続先のデータベース名

-h hostname --host=hostname
マシンのホスト名

-p port --port=port
ポート

-q--quiet
ステータスメッセージを表示しない

-t seconds --timeout=seconds
最大待機時間(デフォルト3秒)

-U username --username=username
ユーザー

-V--version
pg_isreadyバージョンを表示

-?--help
ヘルプ

以下は、実際にローカルにあるPostgreSQLに接続した例となります。

pg_isready -h localhost -p 5432

<出力結果>
localhost:5432 - accepting connections

戻り値を確認します。

echo $?

<出力結果>
0

戻り値は、以下の通りとなります。

<戻り値>
0 接続を受けつけている
1 接続拒否
2 応答なし
3 無効なパラメーターで試行が不可

試しに、使用していないポートを指定すると以下の結果が返ります。

pg_isready -h localhost -p 5433

<出力結果>
localhost:5433 - no response

echo $?

<出力結果>
2