'\" t
.\"     Title: pg_isready
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net>
.\"      Date: 2026
.\"    Manual: PostgreSQL 18.6 Documentation
.\"    Source: PostgreSQL 18.6
.\"  Language: English
.\"
.TH "PG_ISREADY" "1" "2026" "PostgreSQL 18.6" "PostgreSQL 18.6 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "نام (NAME)"
pg_isready \- بررسی وضعیت اتصال سرور PostgreSQL
.SH "خلاصه دستور (SYNOPSIS)"
.HP \w'\fBpg_isready\fR\ 'u
\fBpg_isready\fR [\fIconnection\-option\fR...] [\fIoption\fR...]
.SH "توضیحات (DESCRIPTION)"
.PP
دستور
pg_isready
ابزاری برای بررسی وضعیت اتصال به یک سرور پایگاه‌دادهٔ
PostgreSQL
است\&. وضعیت خروج، نتیجهٔ بررسی اتصال را مشخص می‌کند\&.
.SH "گزینه‌ها (OPTIONS)"
.PP
\fB\-d \fR\fB\fIdbname\fR\fR
.br
\fB\-\-dbname=\fR\fB\fIdbname\fR\fR
.RS 4
نام پایگاه‌داده برای اتصال را مشخص می‌کند\&. مقدار
\fIdbname\fR
می‌تواند یک
رشتهٔ اتصال (connection string)
باشد\&. در این صورت، پارامترهای رشتهٔ اتصال بر هر گزینهٔ متناقض دیگری در خط فرمان اولویت خواهند داشت\&.
.RE
.PP
\fB\-h \fR\fB\fIhostname\fR\fR
.br
\fB\-\-host=\fR\fB\fIhostname\fR\fR
.RS 4
نام میزبان دستگاهی را که سرور روی آن در حال اجرا است مشخص می‌کند\&. اگر این مقدار با یک اسلش آغاز شود، به عنوان دایرکتوری سوکت Unix\-domain استفاده می‌شود\&.
.RE
.PP
\fB\-p \fR\fB\fIport\fR\fR
.br
\fB\-\-port=\fR\fB\fIport\fR\fR
.RS 4
پورت TCP یا پسوند فایل سوکت محلی Unix\-domain را که سرور روی آن منتظر اتصال‌ها است مشخص می‌کند\&. پیش‌فرض، مقدار متغیر محیطی
\fBPGPORT\fR
است یا اگر تنظیم نشده باشد، پورتی است که هنگام کامپایل مشخص شده است (معمولاً 5432)\&.
.RE
.PP
\fB\-q\fR
.br
\fB\-\-quiet\fR
.RS 4
پیام وضعیت را نمایش نده\&. این گزینه هنگام اسکریپت‌نویسی مفید است\&.
.RE
.PP
\fB\-t \fR\fB\fIseconds\fR\fR
.br
\fB\-\-timeout=\fR\fB\fIseconds\fR\fR
.RS 4
حداکثر زمان به ثانیه برای انتظار هنگام تلاش جهت اتصال، پیش از بازگرداندن اینکه سرور پاسخ نمی‌دهد\&. تنظیم روی 0 آن را غیرفعال می‌کند\&. مقدار پیش‌فرض 3 ثانیه است\&.
.RE
.PP
\fB\-U \fR\fB\fIusername\fR\fR
.br
\fB\-\-username=\fR\fB\fIusername\fR\fR
.RS 4
اتصال به پایگاه‌داده به عنوان کاربر
\fIusername\fR
به جای کاربر پیش‌فرض\&.
.RE
.PP
\fB\-V\fR
.br
\fB\-\-version\fR
.RS 4
نسخهٔ
pg_isready
را چاپ کرده و خارج می‌شود\&.
.RE
.PP
\fB\-?\fR
.br
\fB\-\-help\fR
.RS 4
راهنما دربارهٔ آرگومان‌های خط فرمان
pg_isready
را نمایش داده و خارج می‌شود\&.
.RE
.SH "وضعیت خروج (EXIT STATUS)"
.PP
دستور
pg_isready
اگر سرور به‌طور عادی اتصالات را بپذیرد مقدار
0،
اگر سرور اتصالات را رد کند (مثلاً هنگام راه‌اندازی) مقدار
1،
اگر پاسخی به تلاش برای برقراری اتصال داده نشود مقدار
2،
و اگر هیچ تلاشی انجام نشود (مثلاً به دلیل پارامترهای نامعتبر) مقدار
3
را به پوسته برمی‌گرداند\&.
.SH "محیط (ENVIRONMENT)"
.PP
دستور
\fBpg_isready\fR،
مانند اکثر ابزارهای دیگر
PostgreSQL،
از متغیرهای محیطی پشتیبانی‌شده توسط
libpq
نیز استفاده می‌کند (بخش\ \&32.15 را ببینید)\&.
.PP
متغیر محیطی
\fBPG_COLOR\fR
مشخص می‌کند که آیا در پیام‌های عیب‌یابی از رنگ استفاده شود یا خیر\&. مقادیر ممکن عبارت‌اند از
always،
auto
و
never\&.
.SH "نکات (NOTES)"
.PP
برای دریافت وضعیت سرور نیازی به ارائهٔ مقادیر صحیح نام کاربری، گذرواژه یا نام پایگاه‌داده نیست؛ با این حال، اگر مقادیر نادرست ارائه شوند، سرور تلاش ناموفق برای برقراری اتصال را در گزارش‌های خود ثبت خواهد کرد\&.
.SH "مثال‌ها (EXAMPLES)"
.PP
استفادهٔ معمول:
.sp
.if n \{\
.RS 4
.\}
.nf
$ \fBpg_isready\fR
/tmp:5432 \- accepting connections
$ \fBecho $?\fR
0
.fi
.if n \{\
.RE
.\}
.PP
اجرا با پارامترهای اتصال به یک کلاستر
PostgreSQL
در حال راه‌اندازی:
.sp
.if n \{\
.RS 4
.\}
.nf
$ \fBpg_isready \-h localhost \-p 5433\fR
localhost:5433 \- rejecting connections
$ \fBecho $?\fR
1
.fi
.if n \{\
.RE
.\}
.PP
اجرا با پارامترهای اتصال به یک کلاستر
PostgreSQL
غیرپاسخگو:
.sp
.if n \{\
.RS 4
.\}
.nf
$ \fBpg_isready \-h someremotehost\fR
someremotehost:5432 \- no response
$ \fBecho $?\fR
2
.fi
.if n \{\
.RE
.\}
.sp