支援的版本:目前 (17) / 16 / 15 / 14 / 13
開發版本:devel
不支援的版本:12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3

pg_isready

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

概要

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

描述

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

選項

-d dbname
--dbname=dbname

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

-h hostname
--host=hostname

指定伺服器運行的機器的主機名稱。 如果該值以斜線開頭,則將其用作 Unix 域套接字的目錄。

-p port
--port=port

指定伺服器正在偵聽連線的 TCP 埠或本機 Unix 域套接字檔案擴充功能。 預設為 PGPORT 環境變數的值,如果未設定,則預設為編譯時指定的埠,通常為 5432。

-q
--quiet

不顯示狀態訊息。 這在編寫腳本時很有用。

-t seconds
--timeout=seconds

嘗試連線時等待的最大秒數,然後返回伺服器沒有回應。 設定為 0 可停用。 預設值為 3 秒。

-U username
--username=username

以使用者 username 連線到資料庫,而不是預設使用者。

-V
--version

印出 pg_isready 版本並退出。

-?
--help

顯示有關 pg_isready 命令列引數的說明,然後退出。

退出狀態

如果伺服器正常接受連線,pg_isready 會向 shell 返回 0,如果伺服器拒絕連線(例如在啟動期間),則返回 1,如果連線嘗試沒有回應,則返回 2,如果沒有進行嘗試(例如由於無效的參數),則返回 3

環境

與大多數其他 PostgreSQL 工具程式一樣,pg_isready 也使用 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

提交更正

如果您在文件中發現任何不正確、與您使用特定功能的經驗不符或需要進一步澄清的內容,請使用此表單來報告文件問題。