2025年9月25日: PostgreSQL 18 釋出!
支援的版本: 當前 (18) / 17 / 16 / 15 / 14 / 13
開發版本: devel
不支援的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3

pg_isready

pg_isready — 檢查 PostgreSQL 伺服器的連線狀態

概要

pg_isready [連線選項...] [選項...]

描述

pg_isready 是一個用於檢查 PostgreSQL 資料庫伺服器連線狀態的工具。退出狀態指定了連線檢查的結果。

選項

-d dbname
--dbname=dbname

指定要連線的資料庫名稱。dbname 可以是 連線字串。如果是,連線字串引數將覆蓋任何衝突的命令列選項。

-h 主機名
--host=主機名

指定伺服器執行所在機器的主機名。如果值以斜槓開頭,則用作 Unix 域套接字的目錄。

-p
--port=

指定伺服器正在監聽連線的 TCP 埠或本地 Unix 域套接字檔案的副檔名。預設為 PGPORT 環境變數的值,或者如果未設定,則為編譯時指定的埠,通常是 5432。

-q
--quiet

不顯示狀態訊息。這在編寫指令碼時很有用。

-t 秒數
--timeout=秒數

在返回伺服器無響應之前,嘗試連線的最大等待秒數。設定為 0 則停用。預設為 3 秒。

-U 使用者名稱
--username=使用者名稱

使用者名稱 的身份連線到資料庫,而不是使用預設使用者。

-V
--version

列印 pg_isready 版本並退出。

-?
--help

顯示有關 pg_isready 命令列引數的幫助,並退出。

退出狀態

pg_isready 返回 0 到 shell,表示伺服器正常接受連線;返回 1 表示伺服器拒絕連線(例如在啟動過程中);返回 2 表示連線嘗試無響應;返回 3 表示未進行嘗試(例如由於引數無效)。

環境變數

pg_isready 和大多數其他 PostgreSQL 工具一樣,也使用 libpq 支援的環境變數(參見 第 32.15 節)。

環境變數 PG_COLOR 指定是否在診斷訊息中使用顏色。可能的值為 alwaysautonever

註釋

為了獲取伺服器狀態,不必提供正確的使用者名稱、密碼或資料庫名稱;但是,如果提供了不正確的值,伺服器將記錄一次失敗的連線嘗試。

示例

標準用法

$ pg_isready
/tmp:5432 - accepting connections
$ echo $?
0

使用連線引數連線到正在啟動的 PostgreSQL 叢集

$ pg_isready -h localhost -p 5433
localhost:5433 - rejecting connections
$ echo $?
1

使用連線引數連線到無響應的 PostgreSQL 叢集

$ pg_isready -h someremotehost
someremotehost:5432 - no response
$ echo $?
2

提交更正

如果您在文件中發現任何不正確之處、與您對特定功能的實際體驗不符或需要進一步澄清的地方,請使用 此表單 報告文件問題。