<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.pg-parameter-status" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_parameter_status</refname>

<refpurpose>Liefert den aktuellen Wert eines Parameters des Servers</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>pg_parameter_status</methodname>

<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>

<methodparam><type>string</type><parameter>param_name</parameter></methodparam>

</methodsynopsis>

<para>

Ermittelt die aktuelle Einstellung eines Parameters des Servers.

</para>

<para>

Bestimmte Servereinstellungen (Parameter) werden beim Verbindungsaufbau

oder, wenn sich ihr Wert ändert, automatich vom Server gemeldet. Mit

<function>pg_parameter_status</function> können Sie diese Einstellungen

abfragen. Zurückgegeben wird der aktuelle Wert des Parameters, falls dieser

bekannt ist, anderenfalls &false;.

</para>

<para>

In PostgreSQL 8.0 werden die Werte für folgende Parameter zurückgegeben:

<literal>server_version</literal>, <literal>server_encoding</literal>,

<literal>client_encoding</literal>, <literal>is_superuser</literal>,

<literal>session_authorization</literal>, <literal>DateStyle</literal>,

<literal>TimeZone</literal> und <literal>integer_datetimes</literal>.

(<literal>server_encoding</literal>, <literal>TimeZone</literal> und

<literal>integer_datetimes</literal> werden von PostgreSQL vor 8.0 nicht

zurückgegeben.) Beachten Sie, dass <literal>server_version</literal>,

<literal>server_encoding</literal> und <literal>integer_datetimes</literal>

nach dem Start von PostgreSQL nicht mehr verändert werden können.

</para>

<para>

PostgreSQL 7.3 oder darunter geben gar keine Servereinstellungen zurück.

<function>pg_parameter_status</function> kann trotzdem benutzt werden, um

die Werte von <literal>server_version</literal> und

<literal>client_encoding</literal> zu ermitteln. Es wird empfohlen, in

Anwendungen <function>pg_parameter_status</function> zu verwenden, anstatt

speziellen Code zu schreiben, um diese Werte zu erhalten.

</para>

<caution>

<para>

In PostgreSQL-Versionen vor 7.4 wird ein nachträgliches (nach dem Start

des Servers) Ändern von <literal>client_encoding</literal> mit dem

Kommando <literal>SET</literal> von

<function>pg_parameter_status</function> ignoriert.

</para>

</caution>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>connection</parameter></term>

<listitem>

&pgsql.parameter.connection-with-unspecified-default;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>param_name</parameter></term>

<listitem>

<para>

Mögliche Werte für <parameter>param_name</parameter> sind:

<literal>server_version</literal>, <literal>server_encoding</literal>,

<literal>client_encoding</literal>, <literal>is_superuser</literal>,

<literal>session_authorization</literal>, <literal>DateStyle</literal>,

<literal>TimeZone</literal> und <literal>integer_datetimes</literal>.

Es ist zu beachten, dass bei diesem Wert zwischen Groß- und

Kleinschreibung unterschieden wird.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Ein <type>string</type>, der den Wert des Parameters enthält, oder &false;,

falls ein Fehler auftrat oder der Parameter

<parameter>param_name</parameter> ungültig ist.

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&pgsql.changelog.connection-object;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>pg_parameter_status</function>-Beispiel</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

</refsect1>

</refentry>