{"kind": "tool", "major": "18", "item": {"slug": "pg-isready", "name": "pg_isready", "name_zh": "", "category": "Client applications", "summary": "pg_isready \u2014 check the connection status of a PostgreSQL server", "aliases": ["pg_isready"], "content_hash": "bdfdb5489c48c924f8d75f9134db561d2dd06e910602607c57aafeee19e11dfa", "versions": {"10": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "10.23"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/10/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/10/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/10/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/10/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/10/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/10/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/10/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/10/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/10/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "label": "10.23", "major": "10", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/10/postgresql-10-A4.pdf", "bytes": 12631706, "pages": 2591, "sha256": "34497ab9efb45c5bdf1bd11b9016b5451354feb462fa029cf74557a5fa5fbbc1", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/10/postgresql-10-US.pdf", "bytes": 12531684, "pages": 2724, "sha256": "429cc7133ddf4f97c560aa466dc9caea4b718721a8321e293357037cf0af4733", "built_at": "2026-09-26"}}, "tree": "10", "index": "index.html", "major": "10", "pages": 1085, "release": "10.23", "source_url": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "svg_assets": 0, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9"}, "revision": "f9301feba91e2e2566038a36b8cee0e4402db68989538f88670fddd20b1f78ea", "evidence_kind": "English manual and source declarations", "source_sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9"}, "sources": [{"url": "/docs/10/app-pg-isready.html", "file": "app-pg-isready.html", "label": "10.23 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "d6417326828bf14065cef04df415c474fc1a796aae6df2f92c4e31090fc18665"}, {"url": "/docs/10/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "e4330732b6acd6c025a1fbdce45574b23d964de847a1b849ea88b98ab628d2e2"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a033.14).

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "11": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "11.22"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/11/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/11/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/11/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/11/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/11/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/11/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/11/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/11/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/11/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "label": "11.22", "major": "11", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/11/postgresql-11-A4.pdf", "bytes": 13057499, "pages": 2732, "sha256": "41d75855e610d0d9b8802b87dc5b080bef8d7e91c7cf69401fbf8d3cf801b4b5", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/11/postgresql-11-US.pdf", "bytes": 12961189, "pages": 2883, "sha256": "6a8899ef36935a5b7ed2b436207564a567a4ef1eb1c2200195876b8de4d4fa30", "built_at": "2026-09-26"}}, "tree": "11", "index": "index.html", "major": "11", "pages": 1125, "release": "11.22", "source_url": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "svg_assets": 0, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0"}, "revision": "53315ddaf3b3f9e6669fd1edc096bbb2cd4a65ea3e836c89e542b43af9ba3a7f", "evidence_kind": "English manual and source declarations", "source_sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0"}, "sources": [{"url": "/docs/11/app-pg-isready.html", "file": "app-pg-isready.html", "label": "11.22 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "2a67171b43e27e41808b34660e311c9ec72d1b2dd570249c47dbc7df10d09505"}, {"url": "/docs/11/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "3a30e696058b118a55cc42892c39671d9bae86f77e1024d5ebcc4688ad9ab4c3"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a034.14).

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "12": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "12.22"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/12/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/12/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/12/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/12/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/12/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/12/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/12/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/12/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/12/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "label": "12.22", "major": "12", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/12/postgresql-12-A4.pdf", "bytes": 13424351, "pages": 2803, "sha256": "7422cf53fd1939e7a3d2925231a88b0330e468afa5393627cac0ff86158a0621", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/12/postgresql-12-US.pdf", "bytes": 13322565, "pages": 2958, "sha256": "51f3b04e72907fc38512685946223452ea65f84419c60c66241dfa3396035e77", "built_at": "2026-09-26"}}, "tree": "12", "index": "index.html", "major": "12", "pages": 1131, "release": "12.22", "source_url": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "svg_assets": 2, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b"}, "revision": "7a827e97cbfacd7febff75f34443e2043e40723de5b6d8c9d81a9430b65a37e4", "evidence_kind": "English manual and source declarations", "source_sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b"}, "sources": [{"url": "/docs/12/app-pg-isready.html", "file": "app-pg-isready.html", "label": "12.22 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "beed71c4fd8acbc198d0005dbbb79b50a2d1f528cfbdfb3185eb7ef22c438e13"}, {"url": "/docs/12/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "089624dd131f52eea682b304f87a1acb03392ee7bcf78b000699c9b17c7ca22d"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a033.14).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "13": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "13.23"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/13/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/13/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/13/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/13/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/13/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/13/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/13/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/13/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/13/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "label": "13.23", "major": "13", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/13/postgresql-13-A4.pdf", "bytes": 13843239, "pages": 2826, "sha256": "171cc09f90936dbc1cbd503a98ff07ae72ea58ab9771ff051313f1217737799c", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/13/postgresql-13-US.pdf", "bytes": 13739572, "pages": 2984, "sha256": "48d09c6e197d9db4220f41afe83efe848a8661b1b168d3b89419751ecaf6c24d", "built_at": "2026-09-26"}}, "tree": "13", "index": "index.html", "major": "13", "pages": 1139, "release": "13.23", "source_url": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6"}, "revision": "614ee3133270254e476c118cdf6f72af78d4e4b8bbd9b28ed9ab1e14e4e9c0f6", "evidence_kind": "English manual and source declarations", "source_sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6"}, "sources": [{"url": "/docs/13/app-pg-isready.html", "file": "app-pg-isready.html", "label": "13.23 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "212c9abc31b26d27028f23d13e5ad2ca2622f26f6e1f383c6ce2a9a586ae5e7b"}, {"url": "/docs/13/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "2a16c2982d9803edd4bd6920f76b66083e7f2959182d6a3bcec7ccfbac0a9ad8"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a033.14).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "14": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "14.24"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/14/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/14/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/14/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/14/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/14/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/14/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/14/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/14/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/14/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "label": "14.24", "major": "14", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/14/postgresql-14-A4.pdf", "bytes": 14354704, "pages": 2944, "sha256": "8bc6b9dd7b246888bb77f0a5e8c39a2eae52e9926569832669c7d1600becb27c", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/14/postgresql-14-US.pdf", "bytes": 14242178, "pages": 3102, "sha256": "b7ecb5a5f62d8b9f73a69e25a7d26ba285373bc53168a553bff7b77955506db4", "built_at": "2026-09-26"}}, "tree": "14", "index": "index.html", "major": "14", "pages": 1158, "release": "14.24", "source_url": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897"}, "revision": "588700d46356d8837c77c7c0a4e71e645fe6535983b8f1830aa8f2e4e41c40ae", "evidence_kind": "English manual and source declarations", "source_sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897"}, "sources": [{"url": "/docs/14/app-pg-isready.html", "file": "app-pg-isready.html", "label": "14.24 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "bef9d1b8ea2207a1ad9548e299db9b0b5d3bb25026996ab51f3fc4973f9e1b1e"}, {"url": "/docs/14/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "5a13567a052954dfe494dfaab9f50919faa1ae56023930fdbb78d45e53feccde"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a034.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "15": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "15.19"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/15/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/15/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/15/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/15/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/15/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/15/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/15/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/15/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/15/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "label": "15.19", "major": "15", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/15/postgresql-15-A4.pdf", "bytes": 14609140, "pages": 2987, "sha256": "66228564a4d16efb47d6a914085716ecfe22ca1566db56bc7c3d82f790646d72", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/15/postgresql-15-US.pdf", "bytes": 14495690, "pages": 3153, "sha256": "645a498c2390d47a6223ec74770631185807a19c484edb0fc5a295d9f460bc02", "built_at": "2026-09-26"}}, "tree": "15", "index": "index.html", "major": "15", "pages": 1168, "release": "15.19", "source_url": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89"}, "revision": "6af958c6520151fc7697d56e0616b03fb00522c4568158674d452ae0644ba545", "evidence_kind": "English manual and source declarations", "source_sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89"}, "sources": [{"url": "/docs/15/app-pg-isready.html", "file": "app-pg-isready.html", "label": "15.19 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "d6e25742f8f793ccb9d03aa7204efadaa0965f227dd6807df0cc64129bfece9e"}, {"url": "/docs/15/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "015b2ea2bd205946a55a1b837e735570631bac831c92074a6bf58444f9a3cb98"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a034.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "16": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "16.15"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/16/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/16/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/16/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/16/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/16/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/16/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/16/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/16/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/16/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "label": "16.15", "major": "16", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/16/postgresql-16-A4.pdf", "bytes": 15282337, "pages": 3055, "sha256": "4bb6c1f63deedac98736d8c4c7bc0fad0ac24e85b07e21ee10411872f06afd06", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/16/postgresql-16-US.pdf", "bytes": 15164148, "pages": 3220, "sha256": "5b6b6166c89991199e144bb0ae34c17a5f29826251dbf19db1abc0df3a3e771b", "built_at": "2026-09-26"}}, "tree": "16", "index": "index.html", "major": "16", "pages": 1169, "release": "16.15", "source_url": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed"}, "revision": "3c21e58b35318021716440e67bb8bafd392b6a2b965a244d90e9e33c99e0bdef", "evidence_kind": "English manual and source declarations", "source_sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed"}, "sources": [{"url": "/docs/16/app-pg-isready.html", "file": "app-pg-isready.html", "label": "16.15 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "786c2dc50c60465ae8e5820c9b68910fdbc7da0024e497dee89dd164748c7940"}, {"url": "/docs/16/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "a28c30c3c0f8783e16d56413a0b6fd39487e336da1683b29b60abf1c229cef26"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a034.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "17": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "17.11"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/17/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/17/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/17/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/17/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/17/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/17/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/17/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/17/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/17/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "label": "17.11", "major": "17", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/17/postgresql-17-A4.pdf", "bytes": 15521293, "pages": 3099, "sha256": "1991354df0dc89e70ec39328c28988ef8b19c6a93671dab3893650b63e9f4e36", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/17/postgresql-17-US.pdf", "bytes": 15398150, "pages": 3270, "sha256": "07696c8f38abf31babf22d2db337093936e7c472d2af36d050b000c49bbcf52c", "built_at": "2026-09-26"}}, "tree": "17", "index": "index.html", "major": "17", "pages": 1143, "release": "17.11", "source_url": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979"}, "revision": "58419c9b0dd42cb34c8d53695bb025a7e582edf55ccd4c5bcb1c2c7c71a37487", "evidence_kind": "English manual and source declarations", "source_sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979"}, "sources": [{"url": "/docs/17/app-pg-isready.html", "file": "app-pg-isready.html", "label": "17.11 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "f25682500d4e2bdb2109fbf568f750df1dec8883b332fe771875020bd28f502d"}, {"url": "/docs/17/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "3194fc72ddad8e2fcba55f8e007f83413cb352146cb65aaa9457a18d0314ee1b"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a032.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "18": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "18.6"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/18/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/18/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/18/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/18/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/18/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/18/postgresql-18-A4.pdf", "bytes": 15865106, "pages": 3154, "sha256": "19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/18/postgresql-18-US.pdf", "bytes": 15748059, "pages": 3328, "sha256": "facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319", "built_at": "2026-09-26"}}, "tree": "18", "index": "index.html", "major": "18", "pages": 1148, "release": "18.6", "source_url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "revision": "ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8", "evidence_kind": "English manual and source declarations", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "sources": [{"url": "/docs/18/app-pg-isready.html", "file": "app-pg-isready.html", "label": "18.6 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "6e6424b4abc97251d901e24fef966ddfb326156d4ae8b6e2425829ee088909c8"}, {"url": "/docs/18/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "68f726af77272fe73a827be2b7b5958d0f2239a6f8ed44264e9d42496bfa4fd0"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a032.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "19": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "19beta4"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/19/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/19/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/19/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/19/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/19/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/19/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/19/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/19/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/19/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "label": "19beta4", "major": "19", "channel": "preview", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/19/postgresql-19-A4.pdf", "bytes": 16064841, "pages": 3052, "sha256": "4dd099e4125c591128fc5f3ebd02178dc24781f9e5ae629f96d67c4c8547427b", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/19/postgresql-19-US.pdf", "bytes": 15974616, "pages": 3225, "sha256": "61971fa857f0956d47341a0388fa6af9ae10acf691d4b2fc009007d384b0342b", "built_at": "2026-09-26"}}, "tree": "19", "index": "index.html", "major": "19", "pages": 1155, "release": "19beta4", "source_url": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "svg_assets": 5, "source_mode": "en SGML built with pinned official archive", "source_sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86"}, "revision": "1bbbbf4133d426f0e4304010688d2984c30fb67df0cc3a61b3e37eb3f6f37833", "evidence_kind": "English manual and source declarations", "source_sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86"}, "sources": [{"url": "/docs/19/app-pg-isready.html", "file": "app-pg-isready.html", "label": "19beta4 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "73610e5d9fa93847e531d40db7c1a77d822c68311810ceba23ff73e3cfc684dc"}, {"url": "/docs/19/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "c827f460db781b39da305303c88e73729a419cd2b2b9dedb126d8ad5cbf02c95"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a032.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "20": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "20devel"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/devel/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/devel/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/devel/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/devel/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/devel/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/devel/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/devel/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/devel/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/devel/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "label": "20devel", "major": "20", "channel": "devel", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/20/postgresql-20-A4.pdf", "bytes": 16030631, "pages": 3052, "sha256": "bd5d82c0ce38fc18f92a0447818a91a193a261776bca1c37564bf9a683e177d0", "built_at": "2026-09-28"}, "US": {"url": "/files/documentation/pdf/20/postgresql-20-US.pdf", "bytes": 15936613, "pages": 3223, "sha256": "d97d9e0db479a02f4234b175f50fcad70c3661619afc8d6df9b9437882e3c299", "built_at": "2026-09-28"}}, "tree": "0", "index": "index.html", "major": "20", "pages": 1156, "release": "20devel", "source_url": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "svg_assets": 6, "source_mode": "en SGML built with pinned official archive", "source_sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41", "source_snapshot_utc": "26-Sep-2026 20:22"}, "revision": "2eba5e0fd4c3bffb2803247b6cd537878e9d6ee5a6dfbe3c50ece8b421b80918", "evidence_kind": "English manual and source declarations", "source_sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41"}, "sources": [{"url": "/docs/devel/app-pg-isready.html", "file": "app-pg-isready.html", "label": "20devel English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "33b4f7539b0796a17ff984d13c7ef64725aa3a8ac3ce34875fcbf6ab28c2e553"}, {"url": "/docs/devel/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "a6c7ba748fa1d9feac5bb7cde41d1d36a1f4c26d5963e07fb103d02918b2a8ca"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a032.14).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}}}, "snapshot": {"facts": [{"label": "Documented executable", "value": "pg_isready"}, {"label": "Executable version", "value": "18.6"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "8"}], "tables": [{"key": "options", "rows": [{"summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-h hostname --host= hostname"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-p port --port= port"}}, {"summary": "Do not display status message. This is useful when scripting.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-q --quiet"}}, {"summary": "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.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-t seconds --timeout= seconds"}}, {"summary": "Connect to the database as the user username instead of the default.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-U username --username= username"}}, {"summary": "Print the pg_isready version and exit.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-V --version"}}, {"summary": "Show help about pg_isready command line arguments, and exit.", "signature": {"url": "/docs/18/app-pg-isready.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["-d dbname", "--dbname= dbname"], "summary": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/18/app-pg-isready.html", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "summary": "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.", "signature": "-h hostname --host= hostname", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-p port", "--port= port"], "summary": "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.", "signature": "-p port --port= port", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-q", "--quiet"], "summary": "Do not display status message. This is useful when scripting.", "signature": "-q --quiet", "source_url": "/docs/18/app-pg-isready.html", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "summary": "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.", "signature": "-t seconds --timeout= seconds", "source_url": "/docs/18/app-pg-isready.html", "description": "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."}, {"names": ["-U username", "--username= username"], "summary": "Connect to the database as the user username instead of the default.", "signature": "-U username --username= username", "source_url": "/docs/18/app-pg-isready.html", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "summary": "Print the pg_isready version and exit.", "signature": "-V --version", "source_url": "/docs/18/app-pg-isready.html", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_isready command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/18/app-pg-isready.html", "description": "Show help about pg_isready command line arguments, and exit."}], "related": [], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/18/postgresql-18-A4.pdf", "bytes": 15865106, "pages": 3154, "sha256": "19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/18/postgresql-18-US.pdf", "bytes": 15748059, "pages": 3328, "sha256": "facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319", "built_at": "2026-09-26"}}, "tree": "18", "index": "index.html", "major": "18", "pages": 1148, "release": "18.6", "source_url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "revision": "ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8", "evidence_kind": "English manual and source declarations", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "sources": [{"url": "/docs/18/app-pg-isready.html", "file": "app-pg-isready.html", "label": "18.6 English manual \u00b7 app-pg-isready.html", "anchor": "", "sha256": "6e6424b4abc97251d901e24fef966ddfb326156d4ae8b6e2425829ee088909c8"}, {"url": "/docs/18/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "68f726af77272fe73a827be2b7b5958d0f2239a6f8ed44264e9d42496bfa4fd0"}], "sections": [], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "signature": "pg_isready [ connection-option ...] [ option ...]", "description": ["pg_isready \u2014 check the connection status of a PostgreSQL server"], "environment": [], "manual_html": "
\n
\n
\n

pg_isready

\n

pg_isready \u2014 check the connection status of a PostgreSQL server

\n
\n
\n

Synopsis

\n
\n

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

\n
\n
\n
\n

Description

\n

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.

\n
\n
\n

Options

\n
\n
\n
-d dbname
--dbname=dbname
\n
\n

Specifies the name of the database to connect to. The dbname can be a connection string. If so, connection string parameters will override any conflicting command line options.

\n
\n
-h hostname
--host=hostname
\n
\n

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.

\n
\n
-p port
--port=port
\n
\n

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.

\n
\n
-q
--quiet
\n
\n

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

\n
\n
-t seconds
--timeout=seconds
\n
\n

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.

\n
\n
-U username
--username=username
\n
\n

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

\n
\n
-V
--version
\n
\n

Print the pg_isready version and exit.

\n
\n
-?
--help
\n
\n

Show help about pg_isready command line arguments, and exit.

\n
\n
\n
\n
\n
\n

Exit Status

\n

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).

\n
\n
\n

Environment

\n

pg_isready, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section\u00a032.15).

\n

The environment variable PG_COLOR specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

\n
\n
\n

Notes

\n

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.

\n
\n
\n

Examples

\n

Standard Usage:

\n
$ pg_isready\n/tmp:5432 - accepting connections\n$ echo $?\n0\n
\n

Running with connection parameters to a PostgreSQL cluster in startup:

\n
$ pg_isready -h localhost -p 5433\nlocalhost:5433 - rejecting connections\n$ echo $?\n1\n
\n

Running with connection parameters to a non-responsive PostgreSQL cluster:

\n
$ pg_isready -h someremotehost\nsomeremotehost:5432 - no response\n$ echo $?\n2\n
\n
\n
", "manual_path": "app-pg-isready.html", "comparison_data": {"options": [{"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "Specifies the name of the database to connect to. The dbname can be a connection string . If so, connection string parameters will override any conflicting command line options."}, {"names": ["-h hostname", "--host= hostname"], "signature": "-h hostname --host= hostname", "description": "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."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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."}, {"names": ["-q", "--quiet"], "signature": "-q --quiet", "description": "Do not display status message. This is useful when scripting."}, {"names": ["-t seconds", "--timeout= seconds"], "signature": "-t seconds --timeout= seconds", "description": "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."}, {"names": ["-U username", "--username= username"], "signature": "-U username --username= username", "description": "Connect to the database as the user username instead of the default."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_isready version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_isready command line arguments, and exit."}], "synopsis": ["pg_isready [ connection-option ...] [ option ...]"], "environment": []}, "comparison_hash": "8525c44d4a3f398e1aee9846a2dc02320c2b9e94d11f3ae9c90992fcbb0c5455"}, "comparison": {"left": "17", "right": "18", "status": "unchanged", "diff": ""}}