Name

pg_isready — check the connection status of a PostgreSQL™ server

Synopsis

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

Options

-d dbname, --dbname=dbname

Specifies the name of the database to connect to.

If this parameter contains an = sign or starts with a valid URI prefix (postgresql:// or postgres://), it is treated as a conninfo string. See the section called “Connection Strings” for more information.

-h hostname, --host=hostname

Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix-domain socket.

-p port, --port=port

Specifies the TCP port or the local Unix-domain socket file extension on which the server is listening for connections. Defaults to the value of the PGPORT environment variable or, if not set, to the port specified at compile time, usually 5432.

-q, --quiet

Do not display status message. This is useful when scripting.

-t seconds, --timeout=seconds

The maximum number of seconds to wait when attempting connection before returning that the server is not responding. Setting to 0 disables. The default is 3 seconds.

-U username, --username=username

Connect to the database as the user username instead of the default.

-V, --version

Print the pg_isready version and exit.

-?, --help

Show help about pg_isready command line arguments, and exit.