PHP 8.4.1 Released!

pg_parameter_status

(PHP 5, PHP 7, PHP 8)

pg_parameter_statusProcura uma configuração de parâmetro atual do servidor

Descrição

pg_parameter_status(PgSql\Connection $connection = ?, string $param_name): string

Procura uma configuração de parâmetro atual do servidor.

Certos valores de parâmetros são reportados automaticamente pelo servidor na inicialização da conexão ou sempre que seus valores mudam. pg_parameter_status() pode ser usado para interrogar essas configurações. Ele retorna o valor atual de um parâmetro, se conhecido, ou false se o parâmetro não for conhecido.

Os parâmetros relatados no PostgreSQL 8.0 incluem server_version, server_encoding, client_encoding, is_superuser, session_authorization, DateStyle, TimeZone e integer_datetimes. (server_encoding, TimeZone e integer_datetimes não foram relatados por versões anteriores a 8.0.) Observe que server_version, server_encoding e integer_datetimes não podem ser alterados após a inicialização do PostgreSQL.

Servidores PostgreSQL 7.3 ou inferiores não informam configurações de parâmetros, pg_parameter_status() inclui lógica para obter valores para server_version e client_encoding de qualquer maneira. As aplicações são incentivadas a usar pg_parameter_status() em vez de código ad hoc para determinar esses valores.

Cuidado

Em um servidor PostgreSQL anterior à versão 7.4, alterar client_encoding via SET após a inicialização da conexão não será refletido por pg_parameter_status().

Parâmetros

connection

Uma instância de PgSql\Connection. Quando o parâmetro connection não for especificado, a conexão padrão será usada. A conexão padrão é a última conexão feita por pg_connect() ou pg_pconnect().

Aviso

A partir do PHP 8.1.0, usar a conexão padrão tornou-se defasado.

param_name

Os possíveis valores de param_name incluem server_version, server_encoding, client_encoding, is_superuser, session_authorization, DateStyle, TimeZone e integer_datetimes. Observe que esse valor diferencia maiúsculas de minúsculas.

Valor Retornado

Uma string contendo o valor do parâmetro, false em caso de falha ou param_name inválido.

Registro de Alterações

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

Exemplos

Exemplo #1 Exemplo de pg_parameter_status()

<?php
$dbconn
= pg_connect("dbname=publisher") or die("Não foi possível conectar");

echo
"Codificação de servidor: ", pg_parameter_status($dbconn, "server_encoding");
?>

O exemplo acima produzirá:

Codificação de servidor: SQL_ASCII

adicione uma nota

Notas Enviadas por Usuários (em inglês)

Não há notas de usuários para esta página.
To Top