-
Notifications
You must be signed in to change notification settings - Fork 706
/
pg-parameter-status.xml
145 lines (138 loc) · 4.7 KB
/
pg-parameter-status.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.pg-parameter-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_parameter_status</refname>
<refpurpose>Looks up a current parameter setting of the server</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>
Looks up a current parameter setting of the server.
</para>
<para>
Certain parameter values are reported by the server automatically at
connection startup or whenever their values change. <function>pg_parameter_status</function> can be
used to interrogate these settings. It returns the current value of a
parameter if known, or &false; if the parameter is not known.
</para>
<para>
Parameters reported as of PostgreSQL 8.0 include <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>, and <literal>integer_datetimes</literal>.
(<literal>server_encoding</literal>, <literal>TimeZone</literal>, and
<literal>integer_datetimes</literal> were not reported by releases before 8.0.) Note that
<literal>server_version</literal>, <literal>server_encoding</literal> and <literal>integer_datetimes</literal>
cannot change after PostgreSQL startup.
</para>
<para>
PostgreSQL 7.3 or lower servers do not report parameter settings,
<function>pg_parameter_status</function>
includes logic to obtain values for <literal>server_version</literal> and
<literal>client_encoding</literal>
anyway. Applications are encouraged to use <function>pg_parameter_status</function> rather than ad
hoc code to determine these values.
</para>
<caution>
<para>
On a pre-7.4
PostgreSQL server, changing <literal>client_encoding</literal> via <literal>SET</literal> after connection startup will
not be reflected by <function>pg_parameter_status</function>.
</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>
Possible <parameter>param_name</parameter> values include <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>, and
<literal>integer_datetimes</literal>. Note that this value is case-sensitive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>A <type>string</type> containing the value of the parameter, &false; on failure or invalid
<parameter>param_name</parameter>.</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> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=publisher") or die("Could not connect");
echo "Server encoding: ", pg_parameter_status($dbconn, "server_encoding");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Server encoding: SQL_ASCII
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->