pg_result_status
Get status of query result
Description
stringint pg_result_status(PgSql\Result $result
, int $mode
= PGSQL_STATUS_LONG
)
Parameters
-
result
-
An PgSql\Result instance, returned by pg_query,
pg_query_params or pg_execute(among others).
-
mode
-
Either PGSQL_STATUS_LONG
to return the numeric status
of the result
, or PGSQL_STATUS_STRING
to return the command tag of the result
.
If not specified, PGSQL_STATUS_LONG
is the default.
Return Values
Possible return values are PGSQL_EMPTY_QUERY
,
PGSQL_COMMAND_OK
, PGSQL_TUPLES_OK
, PGSQL_COPY_OUT
,
PGSQL_COPY_IN
, PGSQL_BAD_RESPONSE
, PGSQL_NONFATAL_ERROR
and
PGSQL_FATAL_ERROR
if PGSQL_STATUS_LONG
is
specified. Otherwise, a string containing the PostgreSQL command tag is returned.
Examples
Example #1 pg_result_status example
<?php
// Connect to the database
$conn = pg_pconnect("dbname=publisher");
// Execute a COPY
$result = pg_query($conn, "COPY authors FROM STDIN;");
// Get the result status
$status = pg_result_status($result);
// Determine status
if ($status == PGSQL_COPY_IN)
echo "Copy began.";
else
echo "Copy failed.";
?>
The above example will output: