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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.db2-pconnect">
<refnamediv>
<refname>db2_pconnect</refname>
<refpurpose>
Returns a persistent connection to a database
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>db2_pconnect</methodname>
<methodparam><type>string</type><parameter>database</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns a persistent connection to an IBM DB2 Universal Database, IBM
Cloudscape, or Apache Derby database. For more information on persistent
connections, refer to <xref linkend='features.persistent-connections' />.
</para>
<para>
Calling <function>db2_close</function> on a persistent connection always
returns &true;, but the underlying DB2 client connection remains open and
waiting to serve the next matching <function>db2_pconnect</function>
request.
</para>
<para>
Note that you are strongly urged to only use persistent connections on
connections with autocommit turned on. If you attempt to combine
transactions with persistent connections, issuing
<function>db2_commit</function> or <function>db2_rollback</function>
against a persistent connection will affect every persistent connection
that is currently using the same underlying DB2 client connection. You may
also rapidly experience locking escalation if you do not use autocommit for
your persistent connections.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database alias in the DB2 client catalog.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The username with which you are connecting to the database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The password with which you are connecting to the database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array of connection options that affect the behavior
of the connection, where valid array keys include:
<variablelist>
<varlistentry>
<term><parameter>autocommit</parameter></term>
<listitem>
<para>
Passing the <literal>DB2_AUTOCOMMIT_ON</literal> value turns
autocommit on for this connection handle.
</para>
<para>
Passing the <literal>DB2_AUTOCOMMIT_OFF</literal> value turns
autocommit off for this connection handle.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a connection handle resource if the connection attempt is
successful. <function>db2_pconnect</function> tries to reuse an existing
connection resource that exactly matches the
<parameter>database</parameter>, <parameter>username</parameter>, and
<parameter>password</parameter> parameters. If the connection attempt fails,
<function>db2_pconnect</function> returns &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>db2_pconnect</function> example</title>
<para>
In the following example, the first call to
<function>db2_pconnect</function> returns a new persistent connection
resource. The second call to <function>db2_pconnect</function> returns
a persistent connection resource that simply reuses the first persistent
connection resource.
</para>
<programlisting role="php">
<![CDATA[
<?php
$database = 'SAMPLE';
$user = 'db2inst1';
$password = 'ibmdb2';
$pconn = db2_pconnect($database, $user, $password);
if ($pconn) {
echo "Persistent connection succeeded.";
}
else {
echo "Persistent connection failed.";
}
$pconn2 = db2_pconnect($database, $user, $password);
if ($pconn) {
echo "Second persistent connection succeeded.";
}
else {
echo "Second persistent connection failed.";
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Persistent connection succeeded.
Second persistent connection succeeded.
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>db2_connect</function></member>
</simplelist>
</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:"../../../../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
-->
|
