sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[PHP 8.1] Use PgSql objects instead of resources (#1009)

Browse source
This commit is contained in:
Sergey Panteleev 2021-10-16 13:45:19 +03:00 committed by GitHub
parent b958b68778
commit c2eca73ef7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
96 changed files with 1666 additions and 353 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
appendices/resources.xml
View file

@ -1173,7 +1173,7 @@
<entry>
<function>pg_lo_close</function>
</entry>
<entry>PostgreSQL Large Object</entry>
<entry>PostgreSQL Large Object (prior to PHP 8.1.0)</entry>
</row>
<row>
<entry>pgsql link</entry>
@ -1218,7 +1218,7 @@
<entry>
<function>pg_close</function>
</entry>
<entry>Link to PostgreSQL database</entry>
<entry>Link to PostgreSQL database (prior to PHP 8.1.0)</entry>
</row>
<row>
<entry>pgsql link persistent</entry>
@ -1293,7 +1293,7 @@
<entry>
<function>pg_free_result</function>
</entry>
<entry>PostgreSQL result</entry>
<entry>PostgreSQL result (prior to PHP 8.1.0)</entry>
</row>
<row>
<entry>pgsql string</entry>

43
language-snippets.ent
View file

@ -1738,18 +1738,55 @@ PHP as of PHP '>
<!-- PGSQL entities -->
<!ENTITY pgsql.parameter.connection '<para xmlns="http://docbook.org/ns/docbook">PostgreSQL database connection resource.</para>'>
<!ENTITY pgsql.parameter.connection '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.</para>'>
<!ENTITY pgsql.parameter.connection-with-unspecified-default '<para xmlns="http://docbook.org/ns/docbook">PostgreSQL database connection resource.
<!ENTITY pgsql.parameter.connection-with-unspecified-default '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.
When <parameter>connection</parameter> is unspecified, the default connection is used.
The default connection is the last connection made by <function>pg_connect</function>
or <function>pg_pconnect</function>.</para>'>
<!ENTITY pgsql.parameter.connection-with-nullable-default '<para xmlns="http://docbook.org/ns/docbook">PostgreSQL database connection resource.
<!ENTITY pgsql.parameter.connection-with-nullable-default '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Connection</classname> instance.
When <parameter>connection</parameter> is &null;, the default connection is used.
The default connection is the last connection made by <function>pg_connect</function>
or <function>pg_pconnect</function>.</para>'>
<!ENTITY pgsql.parameter.result '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Result</classname> instance, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>(among others).</para>'>
<!ENTITY pgsql.parameter.lob '<para xmlns="http://docbook.org/ns/docbook">An <classname>PgSql\Lob</classname> instance, returned by <function>pg_lo_open</function>.</para>'>
<!ENTITY pgsql.changelog.connection-object '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.1.0</entry>
<entry>
The <parameter>connection</parameter> parameter expects an <classname>PgSql\Connection</classname>
instance now; previously, a &resource; was expected.
</entry>
</row>'>
<!ENTITY pgsql.changelog.result-object '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.1.0</entry>
<entry>
The <parameter>result</parameter> parameter expects an <classname>PgSql\Result</classname>
instance now; previously, a &resource; was expected.
</entry>
</row>'>
<!ENTITY pgsql.changelog.lob-object '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.1.0</entry>
<entry>
The <parameter>lob</parameter> parameter expects an <classname>PgSql\Lob</classname>
instance now; previously, a &resource; was expected.
</entry>
</row>'>
<!ENTITY pgsql.changelog.return-result-object '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.1.0</entry>
<entry>
Returns an <classname>PgSql\Result</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>'>
<!-- Common pieces for reference part END -->

3
reference/pgsql/book.xml
View file

@ -24,6 +24,9 @@
&reference.pgsql.constants;
&reference.pgsql.examples;
&reference.pgsql.reference;
&reference.pgsql.pgsql.connection;
&reference.pgsql.pgsql.result;
&reference.pgsql.pgsql.lob;
</book>

29
reference/pgsql/functions/pg-affected-rows.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_affected_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_affected_rows</function> returns the number of tuples
@ -37,11 +37,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -51,10 +47,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of rows affected by the query. If no tuple is
affected, it will return 0.
The number of rows affected by the query. If no tuple is
affected, it will return <literal>0</literal>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

19
reference/pgsql/functions/pg-cancel-query.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_cancel_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_cancel_query</function> cancels an asynchronous query sent with
@ -43,6 +43,23 @@
&return.success;
</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;

3
reference/pgsql/functions/pg-client-encoding.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_client_encoding</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
PostgreSQL supports automatic character set conversion between
@ -68,6 +68,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

9
reference/pgsql/functions/pg-close.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_close</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_close</function> closes the non-persistent
connection to a PostgreSQL database associated with the given
<parameter>connection</parameter> resource.
<parameter>connection</parameter> instance.
</para>
<note>
<para>
@ -26,8 +26,8 @@
</para>
</note>
<para>
If there is open large object resource on the connection, do not
close the connection before closing all large object resources.
If there is open <classname>PgSql\Lob</classname> instance on the connection, do not
close the connection before closing all <classname>PgSql\Lob</classname> instances.
</para>
</refsect1>
@ -63,6 +63,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-connect-poll.xml
View file

@ -14,7 +14,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_connect_poll</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_connect_poll</function> polls the status of a PostgreSQL
@ -45,6 +45,23 @@
<constant>PGSQL_POLLING_ACTIVE</constant>.
</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>
</refentry>
<!-- Keep this comment at the end of the file

27
reference/pgsql/functions/pg-connect.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_connect</methodname>
<type class="union"><type>PgSql\Connection</type><type>false</type></type><methodname>pg_connect</methodname>
<methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
@ -89,10 +89,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
PostgreSQL connection resource on success, &false; on failure.
Returns an <classname>PgSql\Connection</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Returns an <classname>PgSql\Connection</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

19
reference/pgsql/functions/pg-connection-busy.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_connection_busy</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_connection_busy</function> determines whether or not a connection
@ -42,6 +42,23 @@
Returns &true; if the connection is busy, &false; otherwise.
</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;

19
reference/pgsql/functions/pg-connection-reset.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_connection_reset</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_connection_reset</function> resets the connection.
@ -41,6 +41,23 @@
&return.success;
</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;

19
reference/pgsql/functions/pg-connection-status.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_connection_status</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_connection_status</function> returns the status of
@ -42,6 +42,23 @@
<constant>PGSQL_CONNECTION_BAD</constant>.
</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;

20
reference/pgsql/functions/pg-consume-input.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_consume_input</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_consume_input</function> consumes any input waiting to be read
@ -38,6 +38,24 @@
&true; does not necessarily indicate that input was waiting to be read.
</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>
</refentry>
<!-- Keep this comment at the end of the file

21
reference/pgsql/functions/pg-convert.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_convert</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
@ -81,10 +81,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> of converted values, or &false; on error.
An <type>array</type> of converted values, &return.falseforfailure;.
</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>

19
reference/pgsql/functions/pg-copy-from.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_copy_from</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>rows</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
@ -84,6 +84,23 @@
</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>

22
reference/pgsql/functions/pg-copy-to.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_copy_to</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
@ -68,11 +68,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> with one element for each line of <literal>COPY</literal> data.
It returns &false; on failure.
An <type>array</type> with one element for each line of <literal>COPY</literal> data, &return.falseforfailure;.
</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>

6
reference/pgsql/functions/pg-dbname.xml
View file

@ -11,12 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_dbname</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_dbname</function> returns the name of the database
that the given PostgreSQL <parameter>connection</parameter>
resource.
that the given PostgreSQL <parameter>connection</parameter> instance.
</para>
</refsect1>
@ -53,6 +52,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-delete.xml
View file

@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>bool</type></type><methodname>pg_delete</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>conditions</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
@ -93,6 +93,23 @@
via <parameter>flags</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;

3
reference/pgsql/functions/pg-end-copy.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_end_copy</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_end_copy</function> syncs the PostgreSQL frontend
@ -55,6 +55,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-escape-bytea.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_bytea</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@ -68,6 +68,23 @@
</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>

35
reference/pgsql/functions/pg-escape-identifier.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_identifier</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@ -66,29 +66,22 @@
</para>
</refsect1>
<!--
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.5.0</entry>
<entry>added function</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<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;

35
reference/pgsql/functions/pg-escape-literal.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_literal</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@ -64,29 +64,22 @@
</para>
</refsect1>
<!--
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.5.0</entry>
<entry>added function</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<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;

19
reference/pgsql/functions/pg-escape-string.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_string</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@ -63,6 +63,23 @@
</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>

25
reference/pgsql/functions/pg-execute.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_execute</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_execute</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>stmtname</parameter></methodparam>
<methodparam><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
@ -79,7 +79,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A query result resource on success&return.falseforfailure;.</para>
An <classname>PgSql\Result</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">

30
reference/pgsql/functions/pg-fetch-all-columns.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_all_columns</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>field</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_all_columns</function> returns an array that
contains all rows (records) in a particular column of the result resource.
contains all rows (records) in a particular column of the <classname>PgSql\Result</classname> instance.
</para>
&database.fetch-null;
</refsect1>
@ -28,19 +28,14 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
Column number, zero-based, to be retrieved from the result resource. Defaults
to the first column if not specified.
Column number. Defaults to the first column if not specified.
</para>
</listitem>
</varlistentry>
@ -54,6 +49,23 @@
An <type>array</type> with all values in the result column.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

11
reference/pgsql/functions/pg-fetch-all.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_all</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_ASSOC</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_all</function> returns an array that
contains all rows (records) in the result resource.
contains all rows (records) in the <classname>PgSql\Result</classname> instance.
</para>
&database.fetch-null;
</refsect1>
@ -28,11 +28,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -76,6 +72,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
<row>
<entry>7.1.0</entry>
<entry>

25
reference/pgsql/functions/pg-fetch-array.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_fetch_array</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>row</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_BOTH</constant></initializer></methodparam>
</methodsynopsis>
@ -40,11 +40,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -93,6 +89,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

25
reference/pgsql/functions/pg-fetch-assoc.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_fetch_assoc</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>row</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
@ -40,11 +40,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -74,6 +70,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

25
reference/pgsql/functions/pg-fetch-object.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>object</type><type>false</type></type><methodname>pg_fetch_object</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>row</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>class</parameter><initializer>"stdClass"</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>constructor_args</parameter><initializer>[]</initializer></methodparam>
@ -38,11 +38,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -89,6 +85,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

31
reference/pgsql/functions/pg-fetch-result.xml
View file

@ -4,25 +4,25 @@
<refentry xml:id="function.pg-fetch-result" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_fetch_result</refname>
<refpurpose>Returns values from a result resource</refpurpose>
<refpurpose>Returns values from a result instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_result</function> returns the value of a particular
row and field (column) in a PostgreSQL result resource.
row and field (column) in an <classname>PgSql\Result</classname> instance.
</para>
<note>
<para>
@ -38,11 +38,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -82,6 +78,23 @@
of rows in the set, or on any other error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

28
reference/pgsql/functions/pg-fetch-row.xml
View file

@ -11,14 +11,13 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>row</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_NUM</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_row</function> fetches one row of data from
the result associated with the specified
<parameter>result</parameter> resource.
the result associated with the specified <parameter>result</parameter> instance.
</para>
&database.fetch-null;
</refsect1>
@ -30,11 +29,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -63,6 +58,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

31
reference/pgsql/functions/pg-field-is-null.xml
View file

@ -11,18 +11,18 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_is_null</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>int</type><methodname>pg_field_is_null</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_is_null</function> tests if a field in a PostgreSQL
result resource is SQL <literal>NULL</literal> or not.
<function>pg_field_is_null</function> tests if a field in an <classname>PgSql\Result</classname> instance
is SQL <literal>NULL</literal> or not.
</para>
<note>
<para>
@ -38,11 +38,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -74,6 +70,23 @@
if not. &false; is returned if the row is out of range, or upon any other error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-field-name.xml
View file

@ -11,13 +11,13 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_field_name</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_name</function> returns the name of the field
occupying the given <parameter>field</parameter> in the
given PostgreSQL <parameter>result</parameter> resource. Field
given <parameter>result</parameter> instance. Field
numbering starts from 0.
</para>
<note>
@ -34,11 +34,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -59,6 +55,23 @@
The field name.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

28
reference/pgsql/functions/pg-field-num.xml
View file

@ -11,14 +11,13 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_num</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_num</function> will return the number of the
field number that corresponds to the
<parameter>field</parameter> in the given PostgreSQL
<parameter>result</parameter> resource.
<parameter>field</parameter> in the given <parameter>result</parameter> instance.
</para>
<note>
<para>
@ -34,11 +33,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -59,6 +54,23 @@
The field number (numbered from 0), or -1 on error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-field-prtlen.xml
View file

@ -11,13 +11,13 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_prtlen</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row_number</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field_name_or_number</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>int</type><methodname>pg_field_prtlen</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field_name_or_number</parameter></methodparam>
</methodsynopsis>
<para>
@ -49,11 +49,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -76,6 +72,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

25
reference/pgsql/functions/pg-field-size.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_size</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
@ -35,11 +35,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -61,6 +57,23 @@
length field.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-field-table.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>pg_field_table</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>oid_only</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
@ -27,11 +27,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -59,9 +55,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
On success either the fields table name or oid. Or, &false; on failure.
On success either the fields table name or oid, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-field-type-oid.xml
View file

@ -12,13 +12,13 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type></type><methodname>pg_field_type_oid</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_type_oid</function> returns an integer containing the
OID of the base type of the given <parameter>field</parameter> in the
given PostgreSQL <parameter>result</parameter> resource.
given <parameter>result</parameter> instance.
</para>
<para>
You can get more information about the field type by querying PostgreSQL's
@ -42,11 +42,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -67,6 +63,23 @@
The OID of the field's base type.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-field-type.xml
View file

@ -13,13 +13,13 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_field_type</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_type</function> returns a string containing the
base type name of the given <parameter>field</parameter> in the
given PostgreSQL <parameter>result</parameter> resource.
given <parameter>result</parameter> instance.
</para>
<note>
<para>
@ -42,11 +42,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -67,6 +63,23 @@
A <type>string</type> containing the base name of the field's type.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

18
reference/pgsql/functions/pg-flush.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>pg_flush</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_flush</function> flushes any outbound query data waiting to be
@ -39,6 +39,22 @@
</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>
</refentry>
<!-- Keep this comment at the end of the file

27
reference/pgsql/functions/pg-free-result.xml
View file

@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_free_result</function> frees the memory and data associated with the
specified PostgreSQL query result <type>resource</type>.
specified <classname>PgSql\Result</classname> instance.
</para>
<para>
This function need only be called if memory
@ -36,11 +36,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -54,6 +50,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

19
reference/pgsql/functions/pg-get-notify.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_get_notify</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_ASSOC</constant></initializer></methodparam>
</methodsynopsis>
<para>
@ -61,6 +61,23 @@
</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>

19
reference/pgsql/functions/pg-get-pid.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_get_pid</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_get_pid</function> gets the backend's (database server
@ -40,6 +40,23 @@
The backend database process ID.
</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;

28
reference/pgsql/functions/pg-get-result.xml
View file

@ -12,11 +12,11 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_get_result</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_get_result</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_get_result</function> gets the result resource from
<function>pg_get_result</function> gets an <classname>PgSql\Result</classname> instance from
an asynchronous query executed by
<function>pg_send_query</function>, <function>pg_send_query_params</function> or
<function>pg_send_execute</function>.
@ -46,9 +46,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The result <type>resource</type>, or &false; if no more results are available.
An <classname>PgSql\Result</classname> instance, or &false; if no more results are available.
</para>
</refsect1>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

5
reference/pgsql/functions/pg-host.xml
View file

@ -13,11 +13,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_host</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_host</function> returns the host name of the given
PostgreSQL <parameter>connection</parameter> resource is
PostgreSQL <parameter>connection</parameter> instance is
connected to.
</para>
</refsect1>
@ -55,6 +55,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

22
reference/pgsql/functions/pg-insert.xml
View file

@ -12,8 +12,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>string</type><type>bool</type></type><methodname>pg_insert</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>string</type><type>bool</type></type><methodname>pg_insert</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
@ -96,6 +96,24 @@
via <parameter>flags</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.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

3
reference/pgsql/functions/pg-last-error.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_last_error</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_last_error</function> returns the last error message
@ -67,6 +67,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

3
reference/pgsql/functions/pg-last-notice.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>string</type><type>bool</type></type><methodname>pg_last_notice</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_NOTICE_LAST</constant></initializer></methodparam>
</methodsynopsis>
<para>
@ -86,6 +86,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>7.1.0</entry>
<entry>

25
reference/pgsql/functions/pg-last-oid.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type><type>false</type></type><methodname>pg_last_oid</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_last_oid</function> is used to retrieve the
@ -50,11 +50,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -70,6 +66,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

27
reference/pgsql/functions/pg-lo-close.xml
View file

@ -11,12 +11,10 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_close</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_close</function> closes a large
object. <parameter>lob</parameter> is a resource for the
large object from <function>pg_lo_open</function>.
<function>pg_lo_close</function> closes a large object.
</para>
<para>
To use the large object interface, it is necessary to
@ -36,9 +34,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
</variablelist>
@ -51,6 +47,23 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

22
reference/pgsql/functions/pg-lo-create.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_create</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>object_id</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
@ -70,14 +70,30 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A large object <varname>OID</varname> or &false; on error.
A large object <varname>OID</varname>, &return.falseforfailure;.
</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>

19
reference/pgsql/functions/pg-lo-export.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_export</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>oid</parameter></methodparam>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
</methodsynopsis>
@ -68,6 +68,23 @@
&return.success;
</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;

22
reference/pgsql/functions/pg-lo-import.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_import</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>object_id</parameter></methodparam>
</methodsynopsis>
@ -69,11 +69,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <varname>OID</varname> of the newly created large object, or
&false; on failure.
The <varname>OID</varname> of the newly created large object, &return.falseforfailure;.
</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>

35
reference/pgsql/functions/pg-lo-open.xml
View file

@ -10,19 +10,18 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_lo_open</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Lob</type><type>false</type></type><methodname>pg_lo_open</methodname>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>oid</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_open</function> opens a large object in the database
and returns large object resource so that it can be manipulated.
and returns an <classname>PgSql\Lob</classname> instance so that it can be manipulated.
</para>
<warning>
<para>
Do not close the database connection before closing the large
object resource.
Do not close the database connection before closing the <classname>PgSql\Lob</classname> instance.
</para>
</warning>
<para>
@ -70,9 +69,33 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A large object resource or &false; on error.
An <classname>PgSql\Lob</classname> instance, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Returns an <classname>PgSql\Lob</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

23
reference/pgsql/functions/pg-lo-read-all.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_read_all</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_read_all</function> reads a large object and passes
@ -39,9 +39,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
@ -55,6 +53,23 @@
Number of bytes read.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

23
reference/pgsql/functions/pg-lo-read.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>pg_lo_read</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>8192</initializer></methodparam>
</methodsynopsis>
<para>
@ -37,9 +37,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
<varlistentry>
@ -61,6 +59,23 @@
large object, or &false; on error.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

26
reference/pgsql/functions/pg-lo-seek.xml
View file

@ -13,13 +13,12 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_seek</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter><initializer><constant>SEEK_CUR</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_seek</function> seeks a position within a large object
resource.
<function>pg_lo_seek</function> seeks a position within an <classname>PgSql\Lob</classname> instance.
</para>
<para>
To use the large object interface, it is necessary to
@ -34,9 +33,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
<varlistentry>
@ -67,6 +64,23 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

23
reference/pgsql/functions/pg-lo-tell.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_tell</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_tell</function> returns the current position (offset
@ -32,9 +32,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
</variablelist>
@ -48,6 +46,23 @@
object. If there is an error, the return value is negative.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

26
reference/pgsql/functions/pg-lo-truncate.xml
View file

@ -13,12 +13,11 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_truncate</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_lo_truncate</function> truncates a large object
resource.
<function>pg_lo_truncate</function> truncates an <classname>PgSql\Lob</classname> instance.
</para>
<para>
To use the large object interface, it is necessary to
@ -33,9 +32,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
<varlistentry>
@ -56,6 +53,23 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

19
reference/pgsql/functions/pg-lo-unlink.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_unlink</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>oid</parameter></methodparam>
</methodsynopsis>
<para>
@ -57,6 +57,23 @@
&return.success;
</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;

7
reference/pgsql/functions/pg-lo-write.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>pg_lo_write</methodname>
<methodparam><type>resource</type><parameter>lob</parameter></methodparam>
<methodparam><type>PgSql\Lob</type><parameter>lob</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
@ -37,9 +37,7 @@
<varlistentry>
<term><parameter>lob</parameter></term>
<listitem>
<para>
PostgreSQL large object (LOB) resource, returned by <function>pg_lo_open</function>.
</para>
&pgsql.parameter.lob;
</listitem>
</varlistentry>
<varlistentry>
@ -84,6 +82,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.lob-object;
<row>
<entry>8.0.0</entry>
<entry>

21
reference/pgsql/functions/pg-meta-data.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>pg_meta_data</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>extended</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
@ -56,9 +56,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> of the table definition, or &false; on error.
An <type>array</type> of the table definition, &return.falseforfailure;.
</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;

27
reference/pgsql/functions/pg-num-fields.xml
View file

@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_num_fields</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_num_fields</function> returns the number of fields
(columns) in a PostgreSQL result resource.
(columns) in the <classname>PgSql\Result</classname> instance.
</para>
<note>
<para>
@ -31,11 +31,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -48,6 +44,23 @@
The number of fields (columns) in the result. On error, -1 is returned.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

29
reference/pgsql/functions/pg-num-rows.xml
View file

@ -11,11 +11,11 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_num_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_num_rows</function> will return the number of rows in
a PostgreSQL result resource.
an <classname>PgSql\Result</classname> instance.
</para>
<note>
<para>
@ -31,11 +31,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -45,9 +41,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of rows in the result. On error, -1 is returned.
The number of rows in the result. On error, <literal>-1</literal> is returned.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

5
reference/pgsql/functions/pg-options.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_options</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_options</function> will return a string containing
the options specified on the given PostgreSQL
<parameter>connection</parameter> resource.
<parameter>connection</parameter> instance.
</para>
</refsect1>
@ -53,6 +53,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-parameter-status.xml
View file

@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_parameter_status</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>param_name</parameter></methodparam>
</methodsynopsis>
<para>
@ -81,6 +81,23 @@
<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>

29
reference/pgsql/functions/pg-pconnect.xml
View file

@ -10,13 +10,13 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_pconnect</methodname>
<type class="union"><type>PgSql\Connection</type><type>false</type></type><methodname>pg_pconnect</methodname>
<methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_pconnect</function> opens a connection to a
PostgreSQL database. It returns a connection resource that is
PostgreSQL database. It returns an <classname>PgSql\Connection</classname> instance that is
needed by other PostgreSQL functions.
</para>
<para>
@ -85,9 +85,32 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
PostgreSQL connection resource on success, &false; on failure.
Returns an <classname>PgSql\Connection</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.1.0</entry>
<entry>
Returns an <classname>PgSql\Connection</classname> instance now;
previously, a &resource; was returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

3
reference/pgsql/functions/pg-ping.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_ping</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_ping</function> pings a database connection and tries to
@ -51,6 +51,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

5
reference/pgsql/functions/pg-port.xml
View file

@ -13,11 +13,11 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_port</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_port</function> returns the port number that the
given PostgreSQL <parameter>connection</parameter> resource is
given PostgreSQL <parameter>connection</parameter> instance is
connected to.
</para>
</refsect1>
@ -56,6 +56,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

24
reference/pgsql/functions/pg-prepare.xml
View file

@ -11,8 +11,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_prepare</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_prepare</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>stmtname</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
@ -78,9 +78,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A query result resource on success&return.falseforfailure;.
An <classname>PgSql\Result</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

19
reference/pgsql/functions/pg-put-line.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_put_line</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
@ -75,6 +75,23 @@
&return.success;
</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;

25
reference/pgsql/functions/pg-query-params.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_query_params</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_query_params</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
@ -95,7 +95,26 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A query result resource on success&return.falseforfailure;.</para>
An <classname>PgSql\Result</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">

24
reference/pgsql/functions/pg-query.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_query</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<type class="union"><type>PgSql\Result</type><type>false</type></type><methodname>pg_query</methodname>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
@ -84,9 +84,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A query result resource on success&return.falseforfailure;.
An <classname>PgSql\Result</classname> instance on success, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.return-result-object;
&pgsql.changelog.connection-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

26
reference/pgsql/functions/pg-result-error-field.xml
View file

@ -11,12 +11,12 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type><type>null</type></type><methodname>pg_result_error_field</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_code</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_result_error_field</function> returns one of the detailed error message
fields associated with <parameter>result</parameter> resource. It is only available
fields associated with <parameter>result</parameter> instance. It is only available
against a PostgreSQL 7.4 or above server. The error field is specified by
the <parameter>field_code</parameter>.
</para>
@ -39,10 +39,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
A PostgreSQL query result resource from a previously executed
statement.
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -70,6 +67,23 @@
<para>A <type>string</type> containing the contents of the error field, &null; if the field does not exist or &false;
on failure.</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

27
reference/pgsql/functions/pg-result-error.xml
View file

@ -13,11 +13,11 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>pg_result_error</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_result_error</function> returns any error message
associated with the <parameter>result</parameter> resource. Therefore,
associated with the <parameter>result</parameter> instance. Therefore,
the user has a better chance of getting the correct error message than
with <function>pg_last_error</function>.
</para>
@ -39,11 +39,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
</variablelist>
@ -57,6 +53,23 @@
<parameter>result</parameter> parameter, returns &false;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

31
reference/pgsql/functions/pg-result-seek.xml
View file

@ -4,19 +4,19 @@
<refentry xml:id="function.pg-result-seek" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>pg_result_seek</refname>
<refpurpose>Set internal row offset in result resource</refpurpose>
<refpurpose>Set internal row offset in result instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_result_seek</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_result_seek</function> sets the internal row offset in
a result resource.
the <parameter>result</parameter> instance.
</para>
</refsect1>
@ -27,18 +27,14 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
Row to move the internal offset to in the <parameter>result</parameter> resource.
Row to move the internal offset to in the <classname>PgSql\Result</classname> instance.
Rows are numbered starting from zero.
</para>
</listitem>
@ -53,6 +49,23 @@
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

29
reference/pgsql/functions/pg-result-status.xml
View file

@ -13,12 +13,12 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>int</type></type><methodname>pg_result_status</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>PgSql\Result</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>PGSQL_STATUS_LONG</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_result_status</function> returns the status of a result
resource, or the PostgreSQL command completion tag associated with the result
<function>pg_result_status</function> returns the status of the <classname>PgSql\Result</classname> instance,
or the PostgreSQL command completion tag associated with the result
</para>
</refsect1>
@ -29,11 +29,7 @@
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
PostgreSQL query result resource, returned by <function>pg_query</function>,
<function>pg_query_params</function> or <function>pg_execute</function>
(among others).
</para>
&pgsql.parameter.result;
</listitem>
</varlistentry>
<varlistentry>
@ -62,6 +58,23 @@
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&pgsql.changelog.result-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

3
reference/pgsql/functions/pg-select.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>pg_select</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>conditions</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PGSQL_DML_EXEC</constant></initializer></methodparam>
@ -110,6 +110,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>7.1.0</entry>
<entry>

19
reference/pgsql/functions/pg-send-execute.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>pg_send_execute</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>statement_name</parameter></methodparam>
<methodparam><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
@ -71,6 +71,23 @@
to determine the query result.
</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;

19
reference/pgsql/functions/pg-send-prepare.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>pg_send_prepare</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>statement_name</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
@ -71,6 +71,23 @@
</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>

19
reference/pgsql/functions/pg-send-query-params.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>pg_send_query_params</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>array</type><parameter>params</parameter></methodparam>
</methodsynopsis>
@ -70,6 +70,23 @@
to determine the query result.
</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;

19
reference/pgsql/functions/pg-send-query.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>pg_send_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
</methodsynopsis>
<para>
@ -69,6 +69,23 @@
to determine the query result.
</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;

21
reference/pgsql/functions/pg-set-client-encoding.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_set_client_encoding</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
@ -65,10 +65,27 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns 0 on success or -1 on error.
Returns <literal>0</literal> on success or <literal>-1</literal> on error.
</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>

19
reference/pgsql/functions/pg-set-error-verbosity.xml
View file

@ -14,7 +14,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_set_error_verbosity</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>int</type><parameter>verbosity</parameter></methodparam>
</methodsynopsis>
<para>
@ -64,6 +64,23 @@
or <constant>PGSQL_ERRORS_VERBOSE</constant>.
</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;

20
reference/pgsql/functions/pg-socket.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>pg_socket</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_socket</function> returns a read only <type>resource</type>
@ -42,6 +42,24 @@
A socket resource on success&return.falseforfailure;.
</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>
</refentry>
<!-- Keep this comment at the end of the file

3
reference/pgsql/functions/pg-trace.xml
View file

@ -13,7 +13,7 @@
<type>bool</type><methodname>pg_trace</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>mode</parameter><initializer>"w"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_trace</function> enables tracing of the PostgreSQL
@ -79,6 +79,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-transaction-status.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_transaction_status</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
Returns the current in-transaction status of the server.
@ -51,6 +51,23 @@
has been sent to the server and not yet completed.
</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;

5
reference/pgsql/functions/pg-tty.xml
View file

@ -13,12 +13,12 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_tty</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_tty</function> returns the TTY name that server
side debugging output is sent to on the given PostgreSQL
<parameter>connection</parameter> resource.
<parameter>connection</parameter> instance.
</para>
<note>
<para>
@ -61,6 +61,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

3
reference/pgsql/functions/pg-untrace.xml
View file

@ -11,7 +11,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_untrace</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Stop tracing started by <function>pg_trace</function>.
@ -50,6 +50,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

19
reference/pgsql/functions/pg-update.xml
View file

@ -13,7 +13,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>bool</type></type><methodname>pg_update</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>values</parameter></methodparam>
<methodparam><type>array</type><parameter>conditions</parameter></methodparam>
@ -104,6 +104,23 @@
via <parameter>flags</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;

3
reference/pgsql/functions/pg-version.xml
View file

@ -12,7 +12,7 @@
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_version</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>PgSql\Connection</type><type>null</type></type><parameter>connection</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
<function>pg_version</function> returns an array with the client, protocol
@ -57,6 +57,7 @@
</row>
</thead>
<tbody>
&pgsql.changelog.connection-object;
<row>
<entry>8.0.0</entry>
<entry>

62
reference/pgsql/pgsql.connection.xml Normal file
View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.pgsql-connection" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook">
<title>The PgSql\Connection class</title>
<titleabbrev>PgSql\Connection</titleabbrev>
<partintro>
<!-- {{{ PgSql\Connection intro -->
<section xml:id="pgsql-connection.intro">
&reftitle.intro;
<para>
A fully opaque class which replaces a <literal>pgsql link</literal> resource as of PHP 8.1.0.
</para>
</section>
<!-- }}} -->
<section xml:id="pgsql-connection.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>PgSql\Connection</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>PgSql\Connection</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
</phpdoc:classref>
<!-- 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
-->

62
reference/pgsql/pgsql.lob.xml Normal file
View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.pgsql-lob" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook">
<title>The PgSql\Lob class</title>
<titleabbrev>PgSql\Lob</titleabbrev>
<partintro>
<!-- {{{ PgSql\Lob intro -->
<section xml:id="pgsql-lob.intro">
&reftitle.intro;
<para>
A fully opaque class which replaces a <literal>pgsql large object</literal> resource as of PHP 8.1.0.
</para>
</section>
<!-- }}} -->
<section xml:id="pgsql-lob.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>PgSql\Lob</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>PgSql\Lob</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
</phpdoc:classref>
<!-- 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
-->

62
reference/pgsql/pgsql.result.xml Normal file
View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<phpdoc:classref xml:id="class.pgsql-result" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook">
<title>The PgSql\Result class</title>
<titleabbrev>PgSql\Result</titleabbrev>
<partintro>
<!-- {{{ PgSql\Result intro -->
<section xml:id="pgsql-result.intro">
&reftitle.intro;
<para>
A fully opaque class which replaces a <literal>pgsql result</literal> resource as of PHP 8.1.0.
</para>
</section>
<!-- }}} -->
<section xml:id="pgsql-result.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>PgSql\Result</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>PgSql\Result</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
</phpdoc:classref>
<!-- 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
-->

2
reference/pgsql/setup.xml
View file

@ -31,7 +31,7 @@
<section xml:id="pgsql.resources">
&reftitle.resources;
<para>
There are two resource types used in the PostgreSQL module. The first one
Prior to PHP 8.1.0, there were two resource types used in the PostgreSQL module. The first one
is the link identifier for a database connection, the second a resource
which holds the result of a query.
</para>

4
reference/pgsql/versions.xml
View file

@ -94,6 +94,10 @@
<function name="pg_untrace" from="PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8"/>
<function name="pg_update" from="PHP 4 &gt;= 4.3.0, PHP 5, PHP 7, PHP 8"/>
<function name="pg_version" from="PHP 5, PHP 7, PHP 8"/>
<function name="pgsql\connection" from="PHP 8 &gt;= 8.1.0"/>
<function name="pgsql\result" from="PHP 8 &gt;= 8.1.0"/>
<function name="pgsql\lob" from="PHP 8 &gt;= 8.1.0"/>
</versions>
<!-- Keep this comment at the end of the file
Local variables: