table of contents
- stretch 9.6.12-0+deb9u1
PG_ISREADY(1) | PostgreSQL 9.6.12 Documentation | PG_ISREADY(1) |
NAME¶
pg_isready - check the connection status of a PostgreSQL serverSYNOPSIS¶
pg_isready [connection-option...] [option...]
DESCRIPTION¶
pg_isready is a utility for checking the connection status of a PostgreSQL database server. The exit status specifies the result of the connection check.OPTIONS¶
-d dbname--dbname=dbname
If this parameter contains an = sign or starts with a valid URI prefix (postgresql:// or postgres://), it is treated as a conninfo string. See Section 32.1.1, “Connection Strings”, in the documentation for more information.
-h hostname
--host=hostname
-p port
--port=port
-q
--quiet
-t seconds
--timeout=seconds
-U username
--username=username
-V
--version
-?
--help
EXIT STATUS¶
pg_isready returns 0 to the shell if the server is accepting connections normally, 1 if the server is rejecting connections (for example during startup), 2 if there was no response to the connection attempt, and 3 if no attempt was made (for example due to invalid parameters).ENVIRONMENT¶
pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 32.14, “Environment Variables”, in the documentation).NOTES¶
It is not necessary to supply correct user name, password, or database name values to obtain the server status; however, if incorrect values are provided, the server will log a failed connection attempt.EXAMPLES¶
Standard Usage:$ pg_isready /tmp:5432 - accepting connections $ echo $? 0
Running with connection parameters to a PostgreSQL cluster in startup:
$ pg_isready -h localhost -p 5433 localhost:5433 - rejecting connections $ echo $? 1
Running with connection parameters to a non-responsive PostgreSQL cluster:
$ pg_isready -h someremotehost someremotehost:5432 - no response $ echo $? 2
2019 | PostgreSQL 9.6.12 |