pg_result_status

    (PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

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

    説明

    pg_result_status(PgSql\Result $result, int $mode = PGSQL_STATUS_LONG): string|int

    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.

    参考

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 4 notes

    up
    2
    romix at gmx dot de
    22 years ago
    0 = PGSQL_EMPTY_QUERY
    1 = PGSQL_COMMAND_OK
    2 = PGSQL_TUPLES_OK
    3 = PGSQL_COPY_TO
    4 = PGSQL_COPY_FROM
    5 = PGSQL_BAD_RESPONSE
    6 = PGSQL_NONFATAL_ERROR
    7 = PGSQL_FATAL_ERROR
    up
    2
    Anonymous
    10 years ago
    This function is useful it may not return a full non fatal error but you want to see if the query completes anyway.

    example

    <?PHP
    //connect to pg database
    // create PGSQL

    $PGSTAT = pg_result_status($PGSQL);//defaults to long

    //And run it through a check for example

    if(($PGSTAT == 1) || ($PGSTAT == 2)){
    // for query results;
    }else if(($PGSTAT == 3) || ($PGSTAT == 4)){
    // for copy results;
    }
    if((    $PGSTAT != 0) && ($PGSTAT != 5) && ($PGSTAT != 6) && ($PGSTAT != 7)){
    // your code;
    }else{
    // $ERRORS codes;
    }
    // This is worked the best for me so far I tried using
    // The command tag and I seem to still get an numeric result
    //example
    //$PGSTAT = pg_result_status($PGSQL, PGSQL_COMMAND_OK);
    // got something like tuples ok so I recommend just use default long
    ?>
    or use what ever condition check you feel fit
    up
    -1
    Meej Vaj
    19 years ago
    If on "accident" your program passes pg_result_status a variable that is NOT a actual pg resource, it will return an empty string.
    (This is important to know if you want to make sure a pg resource is "good" before attempting some operation on it).
    up
    -1
    dean at deansas dot org
    11 years ago
    The postgres docs say that PHP should never be able to return PGRES_NONFATAL_ERROR

    "A result of status PGRES_NONFATAL_ERROR will never be returned directly by PQexec or other query execution functions" http://www.postgresql.org/docs/current/static/libpq-exec.html

    Therefore you cannot use this function to check if this query produced a notice.
    ＋add a note
    To Top