無料スクリプト配布のPHP.TO   PHPの実用的なtips PHPマニュアル MySQLマニュアル Apacheマニュアル PostgreSQLマニュアル マニュアル検索    

pg_isready

名前

pg_isready --  PostgreSQL サーバの接続状態を検査する

概要

pg_isready [ connection-option ...] [ option ...]

説明

pg_isready PostgreSQL データベースサーバの接続状態を検査するためのユーティリティです。 終了ステータスが接続検査の結果を示します。

オプション

-d dbname
--dbname= dbname

接続するデータベースの名前を指定します。

このパラメータに = 記号が含まれる場合、または、有効な URI 接頭辞( postgresql:// または postgres:// )から始まる場合、 conninfo 文字列として扱われます。 詳細については 項31.1.1 を参照してください。

-h hostname
--host= hostname

サーバが稼働しているマシンのホスト名を指定します。 値がスラッシュから始まる場合は、Unixドメインソケット用のディレクトリとして使用されます。

-p port
--port= port

サーバが接続を監視しているTCPポートまたはUnixドメインソケットファイルの拡張子を指定します。 デフォルトは PGPORT 環境変数の値、もし設定されていなければ、コンパイル時に指定したポート、通常は5432です。

-q
--quiet

状態メッセージを表示しません。 これはスクリプト処理の際に有用です。

-t seconds
--timeout= seconds

サーバが応答しないことを返す前に、接続試行時に待機する最大秒数です。 ゼロに設定すると無効になります。 デフォルトは3秒です。

-U username
--username= username

デフォルトではなく username ユーザとしてデータベースに接続します。

-V
--version

pg_isready バージョンを表示し終了します。

-?
--help

pg_isready のコマンドライン引数に関する説明を表示し終了します。

終了ステータス

pg_isready は、サーバが通常通り接続を受け付けている場合は 0 を、サーバが接続を拒絶している(例えば起動時)場合は 1 を、接続試行に対する応答がない場合は 2 を、試行が行われなかった(例えば無効なパラメータが原因)場合は 3 をシェルに返します。

環境

他のほとんどの PostgreSQL ユーティリティと同様、 pg_isready libpq によってサポートされる環境変数( 項31.14 参照)を使用します。

注釈

--dbname および --username オプションをログの中で根拠のないエラーメッセージを防ぐために使用することができます。 しかし適切な機能性のために必要なものではありません。

標準的な使用方法を示します。


$
 
pg_isready


/tmp:5432 - accepting connections


$
 
echo $?


0

起動中の PostgreSQL クラスタに対して接続パラメータを付けて実行します。


$ 

pg_isready -h localhost -p 5433


localhost:5433 - rejecting connections


$
 
echo $?


1

応答しない PostgreSQL クラスタに対して接続パラメータを付けて実行します。


$ 

pg_isready -h someremotehost


someremotehost:5432 - no response


$
 
echo $?


2


powered by SEO.CUG.NET