pg_result_status

クエリ結果のステータスを取得する

説明

stringint pg_result_status(PgSql\Result $result, int $mode = PGSQL_STATUS_LONG)

pg_result_status は、 PgSql\Result インスタンスのステータスあるいは結果に関するコマンド補完タグを返します。

パラメータ

result: pg_query、pg_query_params や (様々な関数がありますが、特に) pg_execute が返した PgSql\Result クラスのインスタンス。
mode: result の数値ステータスを返す PGSQL_STATUS_LONG、あるいは result のコマンドタグを返す PGSQL_STATUS_STRING のいずれかです。指定しない場合は PGSQL_STATUS_LONG がデフォルトです。

戻り値

PGSQL_STATUS_LONG が指定された場合の戻り値は以下のいずれかです。 PGSQL_EMPTY_QUERY、 PGSQL_COMMAND_OK、PGSQL_TUPLES_OK、PGSQL_COPY_OUT、 PGSQL_COPY_IN、PGSQL_BAD_RESPONSE、PGSQL_NONFATAL_ERROR および PGSQL_FATAL_ERROR 。それ以外の場合は、PostgreSQL コマンドタグを含む文字列を返します。

変更履歴

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

例

例1 pg_result_status の例


<?php

// データベースに接続する
$conn = pg_pconnect("dbname=publisher");

// COPY を実行する
$result = pg_query($conn, "COPY authors FROM STDIN;");

// 結果ステータスを得る
$status = pg_result_status($result);

// ステータスの内容を調べる
if ($status == PGSQL_COPY_IN)
   echo "Copy began.";
else
   echo "Copy failed.";
 
?>

上の例の出力は以下となります。

Copy began.

参考

pg_connection_status