pg_ping

データベース接続を調べる

説明

bool pg_ping(PgSql\Connectionnull $connection = null)

pg_ping はデータベース接続を調べ、その接続が 壊れている場合には再度接続を試みます。

パラメータ

connection

PgSql\Connection クラスのインスタンス。 connectionnull, の場合、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect または pg_pconnect によって確立された直近の接続です。

警告

PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.1.0 connection は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース を期待していました。
8.0.0 connection は、nullable になりました。

例1 pg_ping の例

<?php 
$conn = pg_pconnect("dbname=publisher");
if (!$conn) {
  echo "エラーが発生しました。\n";
  exit;
}

if (!pg_ping($conn))
  die("接続は壊れています。\n");
?>

参考

  • pg_connection_status
  • pg_connection_reset