PG_ISREADY(1) PostgreSQL 18.6 Documentation PG_ISREADY(1)

pg_isready - بررسی وضعیت اتصال سرور PostgreSQL

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

دستور pg_isready ابزاری برای بررسی وضعیت اتصال به یک سرور پایگاه‌دادهٔ PostgreSQL است. وضعیت خروج، نتیجهٔ بررسی اتصال را مشخص می‌کند.

-d dbname
--dbname=dbname

نام پایگاه‌داده برای اتصال را مشخص می‌کند. مقدار dbname می‌تواند یک رشتهٔ اتصال (connection string) باشد. در این صورت، پارامترهای رشتهٔ اتصال بر هر گزینهٔ متناقض دیگری در خط فرمان اولویت خواهند داشت.

-h hostname
--host=hostname

نام میزبان دستگاهی را که سرور روی آن در حال اجرا است مشخص می‌کند. اگر این مقدار با یک اسلش آغاز شود، به عنوان دایرکتوری سوکت Unix-domain استفاده می‌شود.

-p port
--port=port

پورت TCP یا پسوند فایل سوکت محلی Unix-domain را که سرور روی آن منتظر اتصال‌ها است مشخص می‌کند. پیش‌فرض، مقدار متغیر محیطی PGPORT است یا اگر تنظیم نشده باشد، پورتی است که هنگام کامپایل مشخص شده است (معمولاً 5432).

-q
--quiet

پیام وضعیت را نمایش نده. این گزینه هنگام اسکریپت‌نویسی مفید است.

-t seconds
--timeout=seconds

حداکثر زمان به ثانیه برای انتظار هنگام تلاش جهت اتصال، پیش از بازگرداندن اینکه سرور پاسخ نمی‌دهد. تنظیم روی 0 آن را غیرفعال می‌کند. مقدار پیش‌فرض 3 ثانیه است.

-U username
--username=username

اتصال به پایگاه‌داده به عنوان کاربر username به جای کاربر پیش‌فرض.

-V
--version

نسخهٔ pg_isready را چاپ کرده و خارج می‌شود.

-?
--help

راهنما دربارهٔ آرگومان‌های خط فرمان pg_isready را نمایش داده و خارج می‌شود.

دستور pg_isready اگر سرور به‌طور عادی اتصالات را بپذیرد مقدار 0، اگر سرور اتصالات را رد کند (مثلاً هنگام راه‌اندازی) مقدار 1، اگر پاسخی به تلاش برای برقراری اتصال داده نشود مقدار 2، و اگر هیچ تلاشی انجام نشود (مثلاً به دلیل پارامترهای نامعتبر) مقدار 3 را به پوسته برمی‌گرداند.

دستور pg_isready، مانند اکثر ابزارهای دیگر PostgreSQL، از متغیرهای محیطی پشتیبانی‌شده توسط libpq نیز استفاده می‌کند (بخش 32.15 را ببینید).

متغیر محیطی PG_COLOR مشخص می‌کند که آیا در پیام‌های عیب‌یابی از رنگ استفاده شود یا خیر. مقادیر ممکن عبارت‌اند از always، auto و never.

برای دریافت وضعیت سرور نیازی به ارائهٔ مقادیر صحیح نام کاربری، گذرواژه یا نام پایگاه‌داده نیست؛ با این حال، اگر مقادیر نادرست ارائه شوند، سرور تلاش ناموفق برای برقراری اتصال را در گزارش‌های خود ثبت خواهد کرد.

استفادهٔ معمول:

$ 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
2026 PostgreSQL 18.6