pg_result_status

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

pg_result_status Obtém o status do resultado da consulta

Descrição

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

pg_result_status() retorna o status da instância PgSql\Result ou a tag de conclusão do comando PostgreSQL associada ao resultado.

Parâmetros

result

Uma instância de PgSql\Result, retornada por pg_query(), pg_query_params() ou pg_execute() (entre outras).

mode

Pode ser a constante PGSQL_STATUS_LONG para retornar o status numérico de result ou a constante PGSQL_STATUS_STRING para retornar a etiqueta de comando de result. Se não for especificado, PGSQL_STATUS_LONG é o padrão.

Valor Retornado

Os possíveis valores de retorno são PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK, PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR e PGSQL_FATAL_ERROR se PGSQL_STATUS_LONG for especificado. Caso contrário, uma string contendo a etiqueta de comando do PostgreSQL será retornada.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro result agora espera uma instância de PgSql\Result; anteriormente, um resource era esperado.

Exemplos

Example #1 Exemplo de pg_result_status()

<?php

// Conecta ao banco de dados
$conn = pg_pconnect("dbname=publisher");

// Executa um COPY
$result = pg_query($conn, "COPY authors FROM STDIN;");

// Obtém o status do resultado
$status = pg_result_status($result);

// Determina o status
if ($status == PGSQL_COPY_IN)
   echo "A cópia começou.";
else
   echo "Falha na cópia.";

?>

O exemplo acima produzirá:

A cópia começou.

Veja Também