-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathpg-parameter-status.xml
More file actions
136 lines (129 loc) · 4.13 KB
/
pg-parameter-status.xml
File metadata and controls
136 lines (129 loc) · 4.13 KB
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5f1a92089fa4efe81e9777f87f9ed93f4853898b Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-parameter-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_parameter_status</refname>
<refpurpose>
Consulte un paramètre de configuration courant du serveur
</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>
Consulte un paramètre de configuration courant du serveur.
</para>
<para>
Certaines valeurs de paramètres sont retournées par le serveur
automatiquement lors du démarrage de la connexion ou lorsqu'une valeur
change. <function>pg_parameter_status</function> peut être utilisée pour
interroger ces configurations. La fonction retourne la valeur courante du
paramètre s'il est connu ou &false; si le paramètre est inconnu.
</para>
<para>
Les paramètres retournés par le serveur sont <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> et <literal>integer_datetimes</literal>.
Il est à noter que
<literal>server_version</literal>, <literal>server_encoding</literal> et <literal>integer_datetimes</literal>
ne peuvent changer après le démarrage de PostgreSQL.
</para>
</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>
Les valeurs possibles de <parameter>param_name</parameter> sont
<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> et <literal>integer_datetimes</literal>.
Il est à noter que cette valeur est sensible à la casse.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Une chaîne contenant la valeur du paramètre, &false; en cas d'échec ou
du paramètre <parameter>param_name</parameter> invalide.
</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>Exemple avec <function>pg_parameter_status</function></title>
<programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=publisher") or die("Connexion impossible");
echo "Encodage du serveur : ", pg_parameter_status($dbconn, "server_encoding");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Encodage du serveur : 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
-->