reference/pgsql/functions/pg-close.xml
2ca090342977839edca2f7f4e52305a1b5da6095
...
...
@@ -10,13 +10,13 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<methodsynopsis>
13
-
<type>bool</type><methodname>pg_close</methodname>
14
-
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
13
+
<type>true</type><methodname>pg_close</methodname>
14
+
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
<function>pg_close</function> closes the non-persistent
18
18
connection to a PostgreSQL database associated with the given
19
-
<parameter>connection</parameter> resource.
19
+
<parameter>connection</parameter> instance.
20
20
</para>
21
21
<note>
22
22
<para>
...
...
@@ -26,8 +26,8 @@
26
26
</para>
27
27
</note>
28
28
<para>
29
-
If there is open large object resource on the connection, do not
30
-
close the connection before closing all large object resources.
29
+
If there is open <classname>PgSql\Lob</classname> instance on the connection, do not
30
+
close the connection before closing all <classname>PgSql\Lob</classname> instances.
31
31
</para>
32
32
</refsect1>
33
33

...
...
@@ -38,12 +38,7 @@
38
38
<varlistentry>
39
39
<term><parameter>connection</parameter></term>
40
40
<listitem>
41
-
<para>
42
-
PostgreSQL database connection resource. When
43
-
<parameter>connection</parameter> is not present, the default connection
44
-
is used. The default connection is the last connection made by
45
-
<function>pg_connect</function> or <function>pg_pconnect</function>.
46
-
</para>
41
+
&pgsql.parameter.connection-with-nullable-default;
47
42
</listitem>
48
43
</varlistentry>
49
44
</variablelist>
...
...
@@ -53,10 +48,34 @@
53
48
<refsect1 role="returnvalues">
54
49
&reftitle.returnvalues;
55
50
<para>
56
-
&return.success;
51
+
&return.true.always;
57
52
</para>
58
53
</refsect1>
59
54

55
+
<refsect1 role="changelog">
56
+
&reftitle.changelog;
57
+
<informaltable>
58
+
<tgroup cols="2">
59
+
<thead>
60
+
<row>
61
+
<entry>&Version;</entry>
62
+
<entry>&Description;</entry>
63
+
</row>
64
+
</thead>
65
+
<tbody>
66
+
&return.type.true;
67
+
&pgsql.changelog.connection-object;
68
+
<row>
69
+
<entry>8.0.0</entry>
70
+
<entry>
71
+
<parameter>connection</parameter> is now nullable.
72
+
</entry>
73
+
</row>
74
+
</tbody>
75
+
</tgroup>
76
+
</informaltable>
77
+
</refsect1>
78
+
60
79
<refsect1 role="examples">
61
80
&reftitle.examples;
62
81
<para>
...
...
@@ -91,7 +110,6 @@ Connected successfully
91
110
</para>
92
111
</refsect1>
93
112
</refentry>
94
-

95
113
<!-- Keep this comment at the end of the file
96
114
Local variables:
97
115
mode: sgml
98
116