Initial transition to new structure; WIP

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@181876 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kenneth Schwartz 2005-03-11 16:03:26 +00:00
parent 8c10042cbb
commit 5b37c04045
71 changed files with 1081 additions and 560 deletions

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-affected-rows">
<refnamediv>
<refname>pg_affected_rows</refname>
<refpurpose>Returns number of affected records (tuples)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_affected_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -37,9 +38,15 @@
This function used to be called <literal>pg_cmdtuples()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function> and
<function>pg_num_rows</function>.
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
<refentry id='function.pg-cancel-query'>
<refnamediv>
@ -8,20 +8,27 @@
Cancel asynchronous query
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pg_cancel_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_cancel_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_cancel_query</function> cancel asynchronous query sent by
<function>pg_send_query</function>. You cannot cancel query executed by
<function>pg_query</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_send_query</function> and
<function>pg_connection_busy</function>.
<simplelist>
<member><function>pg_send_query</function></member>
<member><function>pg_connection_busy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.16 -->
<refentry id="function.pg-client-encoding">
<refnamediv>
@ -8,12 +8,13 @@
Gets the client encoding
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pg_client_encoding</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_client_encoding</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_client_encoding</function> returns the client
encoding as the string. The returned string should be either :
@ -34,8 +35,14 @@
The function used to be called <function>pg_clientencoding</function>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_set_client_encoding</function>.
<simplelist>
<member><function>pg_set_client_encoding</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,17 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-close">
<refnamediv>
<refname>pg_close</refname>
<refpurpose>Closes a PostgreSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pg_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_close</function> closes the non-persistent
connection to a PostgreSQL database associated with the given
@ -24,6 +25,14 @@
of the script.
</para>
</note>
<para>
If there is open large object resource on the connection, do not
close the connection before closing all large object resources.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_close</function> example</title>
@ -39,10 +48,6 @@
</programlisting>
</example>
</para>
<para>
If there is open large object resource on the connection, do not
close the connection before closing all large object resources.
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-connect">
<refnamediv>
<refname>pg_connect</refname>
<refpurpose>Open a PostgreSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_connect</methodname>
<methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
@ -24,27 +25,8 @@
resource on success. It returns &false; if the connection could
not be made. <parameter>connection_string</parameter> should be
a quoted string.
<example>
<title>Using <function>pg_connect</function></title>
<programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=mary");
//connect to a database named "mary"
$dbconn2 = pg_connect("host=localhost port=5432 dbname=mary");
// connect to a database named "mary" on "localhost" at port "5432"
$dbconn3 = pg_connect("host=sheep port=5432 dbname=mary user=lamb password=foo");
//connect to a database named "mary" on the host "sheep" with a username and password
$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_connect($conn_string);
//connect to a database named "test" on the host "sheep" with a username and password
?>
]]>
</programlisting>
</example>
</para>
<para>
The arguments available for
<parameter>connection_string</parameter> includes
<parameter>host</parameter>, <parameter>port</parameter>,
@ -67,11 +49,47 @@ $dbconn4 = pg_connect($conn_string);
<command>$conn = pg_connect("host", "port", "options", "tty", "dbname")
</command> has been deprecated.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
See also <function>pg_pconnect</function>,
<function>pg_close</function>, <function>pg_host</function>,
<function>pg_port</function>, <function>pg_tty</function>,
<function>pg_options</function> and <function>pg_dbname</function>.
<example>
<title>Using <function>pg_connect</function></title>
<programlisting role="php">
<![CDATA[
<?php
$dbconn = pg_connect("dbname=mary");
//connect to a database named "mary"
$dbconn2 = pg_connect("host=localhost port=5432 dbname=mary");
// connect to a database named "mary" on "localhost" at port "5432"
$dbconn3 = pg_connect("host=sheep port=5432 dbname=mary user=lamb password=foo");
//connect to a database named "mary" on the host "sheep" with a username and password
$conn_string = "host=sheep port=5432 dbname=test user=lamb password=bar";
$dbconn4 = pg_connect($conn_string);
//connect to a database named "test" on the host "sheep" with a username and password
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_pconnect</function></member>
<member><function>pg_close</function></member>
<member><function>pg_host</function></member>
<member><function>pg_port</function></member>
<member><function>pg_tty</function></member>
<member><function>pg_options</function></member>
<member><function>pg_dbname</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id='function.pg-connection-busy'>
<refnamediv>
@ -8,8 +8,9 @@
Get connection is busy or not
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_connection_busy</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -19,6 +20,10 @@
connection is busy. If it is busy, a previous query is still executing.
If <function>pg_get_result</function> is called, it will be blocked.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_connection_busy</function> example</title>
@ -37,9 +42,15 @@
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connection_status</function> and
<function>pg_get_result</function>.
<simplelist>
<member><function>pg_connection_status</function></member>
<member><function>pg_get_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id='function.pg-connection-reset'>
<refnamediv>
@ -8,8 +8,9 @@
Reset connection (reconnect)
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_connection_reset</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -18,6 +19,10 @@
<function>pg_connection_reset</function> resets the connection.
It is useful for error recovery. &return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_connection_reset</function> example</title>
@ -36,10 +41,16 @@
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connect</function>,
<function>pg_pconnect</function> and
<function>pg_connection_status</function>.
<simplelist>
<member><function>pg_connect</function></member>
<member><function>pg_pconnect</function></member>
<member><function>pg_connection_status</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id='function.pg-connection-status'>
<refnamediv>
@ -8,18 +8,23 @@
Get connection status
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pg_connection_status</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_connection_status</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_connection_status</function> returns a connection status.
Possible statuses are <literal>PGSQL_CONNECTION_OK</literal> and
<literal>PGSQL_CONNECTION_BAD</literal>. The return value 0 as
integer indicates a valid connection.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_connection_status</function> example</title>
@ -38,8 +43,14 @@
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connection_busy</function>.
<simplelist>
<member><function>pg_connection_busy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-convert'>
<refnamediv>
@ -8,15 +8,16 @@
Convert associative array value into suitable for SQL statement
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_convert</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_convert</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_convert</function> checks and converts the values in
<literal>assoc_array</literal> into suitable values for use in a SQL
@ -28,9 +29,15 @@
values on success, &false; otherwise.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_meta_data</function>.
</para>
<simplelist>
<member><function>pg_meta_data</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id='function.pg-copy-from'>
<refnamediv>
@ -8,24 +8,31 @@
Insert records into a table from an array
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pg_copy_from</methodname>
<methodparam><type>resource</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>delimiter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_copy_from</methodname>
<methodparam><type>resource</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>delimiter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_copy_from</function> insert records into a table from
<parameter>rows</parameter>. It issues <literal>COPY FROM</literal> SQL command
internally to insert records.
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_copy_to</function>.
<simplelist>
<member><function>pg_copy_to</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id='function.pg-copy-to'>
<refnamediv>
@ -8,23 +8,30 @@
Copy a table to an array
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_copy_to</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_copy_to</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_copy_to</function> copies a table to an array. It
issues <literal>COPY TO</literal> SQL command internally to
retrieve records. The resulting array is returned. It returns
&false; on failure.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_copy_from</function>.
<simplelist>
<member><function>pg_copy_from</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,23 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-dbname">
<refnamediv>
<refname>pg_dbname</refname>
<refpurpose>Get the database name</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pg_dbname</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_dbname</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_dbname</function> returns the name of the database
that the given PostgreSQL <parameter>connection</parameter>
resource. It returns &false;, if <parameter>connection</parameter>
is not a valid PostgreSQL connection resource.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_dbname</function> example</title>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-delete'>
<refnamediv>
@ -8,15 +8,16 @@
Deletes records
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>pg_delete</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>pg_delete</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_delete</function> deletes record condition specified by
<literal>assoc_array</literal> which has
@ -24,6 +25,10 @@
specified, <function>pg_convert</function> is applied
to <literal>assoc_array</literal> with specified option.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_delete</function> example</title>
@ -44,9 +49,15 @@
</example>
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_convert</function>.
</para>
<simplelist>
<member><function>pg_convert</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,17 +1,18 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-end-copy">
<refnamediv>
<refname>pg_end_copy</refname>
<refpurpose>Sync with PostgreSQL backend</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pg_end_copy</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_end_copy</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_end_copy</function> syncs the PostgreSQL frontend
(usually a web server process) with the PostgreSQL server after
@ -20,9 +21,14 @@
must be issued, otherwise the PostgreSQL server may get out of
sync with the frontend and will report an error. &return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
For further details and an example, see also
<function>pg_put_line</function>.
<simplelist>
<member><function>pg_put_line</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
<refentry id='function.pg-escape-bytea'>
<refnamediv>
@ -8,12 +8,13 @@
Escape binary for bytea type
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pg_escape_bytea</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_bytea</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_escape_bytea</function> escapes string for
bytea datatype. It returns escaped string.
@ -34,9 +35,15 @@
stream error. User must cast to bytea to avoid this error.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_unescape_bytea</function> and
<function>pg_escape_string</function>.
<simplelist>
<member><function>pg_unescape_bytea</function></member>
<member><function>pg_escape_string</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
<refentry id='function.pg-escape-string'>
<refnamediv>
@ -8,12 +8,13 @@
Escape string for text/char type
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pg_escape_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_escape_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_escape_string</function> escapes string for
text/char datatype. It returns escaped string for
@ -25,8 +26,14 @@
This function requires PostgreSQL 7.2 or later.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_escape_bytea</function>
<simplelist>
<member><function>pg_escape_bytea</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,23 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-all">
<refnamediv>
<refname>pg_fetch_all</refname>
<refpurpose>Fetches all rows from a result as an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_fetch_all</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_all</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_all</function> returns an array that
contains all rows (tuples/records) in result resource. It returns
&false;, if there are no rows.
</para>
&database.fetch-null;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>PostgreSQL fetch all</title>
@ -45,11 +50,17 @@ var_dump($arr);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_fetch_row</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_object</function> and
<function>pg_fetch_result</function>.
<simplelist>
<member><function>pg_fetch_row</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,19 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- $Revision: 1.12 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-array">
<refnamediv>
<refname>pg_fetch_array</refname>
<refpurpose>Fetch a row as an array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_fetch_array</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_array</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_array</function> returns an array that
corresponds to the fetched row (tuples/records). It returns
@ -53,6 +54,17 @@
slower than using <function>pg_fetch_row</function>, while it
provides a significant ease of use.
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_array</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_fetch_array</function> example</title>
@ -92,18 +104,16 @@ echo $arr[1] . " <- Row 3 E-mail\n";
</programlisting>
</example>
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_array</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>pg_fetch_row</function>,
<function>pg_fetch_object</function> and
<function>pg_fetch_result</function>.
<simplelist>
<member><function>pg_fetch_row</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,18 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-assoc">
<refnamediv>
<refname>pg_fetch_assoc</refname>
<refpurpose>Fetch a row as an associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_fetch_assoc</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_assoc</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_assoc</function> returns an associative array that
corresponds to the fetched row (tuples/records). It returns
@ -35,6 +36,17 @@
slower than using <function>pg_fetch_row</function>, while it
provides a significant ease of use.
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_assoc</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_fetch_assoc</function> example</title>
@ -63,19 +75,17 @@ while ($row = pg_fetch_assoc($result)) {
</programlisting>
</example>
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_assoc</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>pg_fetch_row</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_object</function> and
<function>pg_fetch_result</function>.
<simplelist>
<member><function>pg_fetch_row</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,19 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- $Revision: 1.15 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-object">
<refnamediv>
<refname>pg_fetch_object</refname>
<refpurpose>Fetch a row as an object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>object</type><methodname>pg_fetch_object</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>pg_fetch_object</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_object</function> returns an object with
properties that correspond to the fetched row. It returns &false;
@ -47,6 +48,17 @@
<parameter>result_type</parameter> may be deleted in future versions.
</para>
</note>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_object</function> will increment
the internal row counter counter by one.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_fetch_object</function> example</title>
@ -81,20 +93,18 @@ pg_close($db_conn);
</programlisting>
</example>
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_object</function> will increment
the internal row counter counter by one.
</para>
</note>
<para>
See also
<function>pg_query</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_assoc</function>,
<function>pg_fetch_row</function> and
<function>pg_fetch_result</function>.
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_assoc</function></member>
<member><function>pg_fetch_row</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,24 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-fetch-result">
<refnamediv>
<refname>pg_fetch_result</refname>
<refpurpose>Returns values from a result resource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>mixed</type><methodname>pg_fetch_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_result</function> returns values from a
<parameter>result</parameter> resource returned by

View file

@ -1,18 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-fetch-row">
<refnamediv>
<refname>pg_fetch_row</refname>
<refpurpose>Get a row as an enumerated array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>pg_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_fetch_row</function> fetches one row of data from
the result associated with the specified
@ -25,6 +26,17 @@
if there are no more rows.
</para>
&database.fetch-null;
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_row</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_fetch_row</function> example</title>
@ -54,19 +66,17 @@ while ($row = pg_fetch_row($result)) {
</programlisting>
</example>
</para>
<note>
<para>
From 4.1.0, <parameter>row</parameter> became optional.
Calling <function>pg_fetch_row</function> will increment
the internal row counter by one.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also
<function>pg_query</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_object</function> and
<function>pg_fetch_result</function>.
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,19 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-field-is-null">
<refnamediv>
<refname>pg_field_is_null</refname>
<refpurpose>Test if a field is &null;</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pg_field_is_null</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_is_null</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_is_null</function> tests if a field is &null; or
not. It returns 1 if the field in the given row is &null;. It
@ -21,6 +22,15 @@
be specified as column index (number) or fieldname (string). Row
numbering starts at 0.
</para>
<note>
<para>
This function used to be called <literal>pg_fieldisnull()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_field_is_null</function> example</title>
@ -42,11 +52,6 @@
</programlisting>
</example>
</para>
<note>
<para>
This function used to be called <literal>pg_fieldisnull()</literal>.
</para>
</note>
</refsect1>
</refentry>

View file

@ -1,24 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-field-name">
<refnamediv>
<refname>pg_field_name</refname>
<refpurpose>Returns the name of a field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pg_field_name</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_field_name</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_name</function> returns the name of the field
occupying the given <parameter>field_number</parameter> in the
given PostgreSQL <parameter>result</parameter> resource. Field
numbering starts from 0.
</para>
<note>
<para>
This function used to be called <literal>pg_fieldname()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting information about fields</title>
@ -40,9 +50,7 @@
?>
]]>
</programlisting>
<para>
The above example would produce the following output:
</para>
&example.outputs;
<screen>
<![CDATA[
column 0
@ -66,13 +74,14 @@ field type: varchar
</screen>
</example>
</para>
<note>
<para>
This function used to be called <literal>pg_fieldname()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_num</function>.
<simplelist>
<member><function>pg_field_num</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,18 +1,19 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-field-num">
<refnamediv>
<refname>pg_field_num</refname>
<refpurpose>Returns the field number of the named field</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pg_field_num</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_num</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>field_name</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_num</function> will return the number of the
column (field) slot that corresponds to the
@ -28,8 +29,14 @@
This function used to be called <literal>pg_fieldnum()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_name</function>.
<simplelist>
<member><function>pg_field_name</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,19 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-field-prtlen">
<refnamediv>
<refname>pg_field_prtlen</refname>
<refpurpose>Returns the printed length</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pg_field_prtlen</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field_name_or_number</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_prtlen</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
<methodparam><type>mixed</type><parameter>field_name_or_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_prtlen</function> returns the actual printed
length (number of characters) of a specific value in a PostgreSQL
@ -31,11 +32,17 @@
</para>
<note>
<para>
This function used to be called <literal>pg_fieldprtlen()</literal>.
This function used to be called <literal>pg_fieldprtlen()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_size</function>.
<simplelist>
<member><function>pg_field_size</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-field-size">
<refnamediv>
@ -8,13 +8,14 @@
Returns the internal storage size of the named field
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pg_field_size</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_size</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>field_number</parameter></methodparam>
</methodsynopsis>
<para>
<function>pg_field_size</function> returns the internal storage
size (in bytes) of the field number in the given PostgreSQL
@ -30,9 +31,15 @@
This function used to be called <literal>pg_fieldsize()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_prtlen</function> and
<function>pg_field_type</function>.
<simplelist>
<member><function>pg_field_prtlen</function></member>
<member><function>pg_field_type</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.pg-field-type-oid">
<refnamediv>
<refname>pg_field_type_oid</refname>
@ -7,8 +7,9 @@
Returns the type ID (OID) for the corresponding field number
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_field_type_oid</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -24,10 +25,16 @@
You can get more information about the field type by querying PostgreSQL
pg_type system table using the ID obtained with this function.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_type</function>,
<function>pg_field_prtlen</function> and
<function>pg_field_name</function>.
<simplelist>
<member><function>pg_field_type</function></member>
<member><function>pg_field_prtlen</function></member>
<member><function>pg_field_name</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.52 -->
<refentry id="function.pg-field-type">
<refnamediv>
@ -8,8 +8,9 @@
Returns the type name for the corresponding field number
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_field_type</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -29,10 +30,16 @@
This function used to be called <literal>pg_fieldtype()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_field_prtlen</function>,
<function>pg_field_name</function> and
<function>pg_field_type_oid</function>.
<simplelist>
<member><function>pg_field_prtlen</function></member>
<member><function>pg_field_name</function></member>
<member><function>pg_field_type_oid</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-free-result">
<refnamediv>
<refname>pg_free_result</refname>
<refpurpose>Free result memory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -27,8 +28,14 @@
This function used to be called <literal>pg_freeresult()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function>.
<simplelist>
<member><function>pg_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id="function.pg-get-notify">
<refnamediv>
<refname>pg_get_notify</refname>
<refpurpose>Ping database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_get_notify</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -20,9 +21,10 @@
contains message name and backend PID is returned. If there is no
message, &false; is returned.
</para>
<para>
See also <function>pg_get_pid</function>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>PostgreSQL NOTIFY message</title>
@ -49,6 +51,15 @@ if (!$notify) {
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>pg_get_pid</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,12 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.pg-get-pid">
<refnamediv>
<refname>pg_get_pid</refname>
<refpurpose>Ping database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_get_pid</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -16,6 +17,10 @@
process) PID. PID is useful to check if <literal>NOTIFY</literal>
message is sent from other process or not.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>PostgreSQL backend PID</title>
@ -35,8 +40,14 @@ $pid = pg_get_pid($conn);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_get_notify</function>.
<simplelist>
<member><function>pg_get_notify</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
<refentry id='function.pg-get-result'>
<refnamediv>
@ -8,8 +8,9 @@
Get asynchronous query result
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_get_result</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-host">
<refnamediv>
@ -8,8 +8,9 @@
Returns the host name associated with the connection
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_host</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -19,9 +20,15 @@
PostgreSQL <parameter>connection</parameter> resource is
connected to.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connect</function> and
<function>pg_pconnect</function>.
<simplelist>
<member><function>pg_connect</function></member>
<member><function>pg_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-insert'>
<refnamediv>
@ -8,8 +8,9 @@
Insert array into table
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_insert</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -28,6 +29,11 @@
If <parameter>options</parameter> is specified, <function>pg_insert</function>
is applied to <parameter>assoc_array</parameter> with specified option.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_insert</function> example</title>
@ -47,10 +53,15 @@
</programlisting>
</example>
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_convert</function>.
</para>
<simplelist>
<member><function>pg_convert</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-last-error">
<refnamediv>
<refname>pg_last_error</refname>
<refpurpose>Get the last error message string of a connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_last_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
@ -31,8 +32,14 @@
This function used to be called <literal>pg_errormessage()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_result_error</function>.
<simplelist>
<member><function>pg_result_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-last-notice">
<refnamediv>
@ -8,8 +8,9 @@
Returns the last notice message from PostgreSQL server
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_last_notice</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -47,9 +48,15 @@
Unless <literal>pgsql.ignore_notice</literal> is set
to 0, notice message cannot be logged.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function> and
<function>pg_last_error</function>.
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_last_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-last-oid">
<refnamediv>
<refname>pg_last_oid</refname>
<refpurpose>Returns the last object's oid</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_last_oid</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -33,9 +34,15 @@
This function used to be called <literal>pg_getlastoid()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function> and
<function>pg_result_status</function>
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_result_status</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-close">
<refnamediv>
<refname>pg_lo_close</refname>
<refpurpose>Close a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_close</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -26,10 +27,16 @@
This function used to be called <literal>pg_loclose()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_open</function>,
<function>pg_lo_create</function> and
<function>pg_lo_import</function>.
<simplelist>
<member><function>pg_lo_open</function></member>
<member><function>pg_lo_create</function></member>
<member><function>pg_lo_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-create">
<refnamediv>
<refname>pg_lo_create</refname>
<refpurpose>Create a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_create</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.6 -->
<refentry id="function.pg-lo-export">
<refnamediv>
<refname>pg_lo_export</refname>
<refpurpose>Export a large object to file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_export</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
@ -29,8 +30,14 @@
This function used to be called <literal>pg_loexport()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_import</function>.
<simplelist>
<member><function>pg_lo_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.6 -->
<refentry id="function.pg-lo-import">
<refnamediv>
<refname>pg_lo_import</refname>
<refpurpose>Import a large object from file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_import</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
@ -38,9 +39,15 @@
This function used to be called <literal>pg_loimport()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_export</function> and
<function>pg_lo_open</function>.
<simplelist>
<member><function>pg_lo_export</function></member>
<member><function>pg_lo_open</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-open">
<refnamediv>
<refname>pg_lo_open</refname>
<refpurpose>Open a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_lo_open</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -37,9 +38,15 @@
This function used to be called <literal>pg_loopen()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_close</function> and
<function>pg_lo_create</function>.
<simplelist>
<member><function>pg_lo_close</function></member>
<member><function>pg_lo_create</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-read-all">
<refnamediv>
@ -8,8 +8,9 @@
Reads an entire large object and send straight to browser
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_read_all</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -30,8 +31,14 @@
This function used to be called <literal>pg_loreadall()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_read</function>.
<simplelist>
<member><function>pg_lo_read</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.74 -->
<refentry id="function.pg-lo-read">
<refnamediv>
<refname>pg_lo_read</refname>
<refpurpose>Read a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_lo_read</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -30,8 +31,14 @@
This function used to be called <literal>pg_loread()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_read_all</function>.
<simplelist>
<member><function>pg_lo_read_all</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id='function.pg-lo-seek'>
<refnamediv>
@ -8,8 +8,9 @@
Seeks position of large object
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_seek</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -21,8 +22,14 @@
resource. <parameter>whence</parameter> is PGSQL_SEEK_SET,
PGSQL_SEEK_CUR or PGSQL_SEEK_END.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_tell</function>.
<simplelist>
<member><function>pg_lo_tell</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.74 -->
<refentry id='function.pg-lo-tell'>
<refnamediv>
@ -8,8 +8,9 @@
Returns current position of large object
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_tell</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -18,8 +19,14 @@
<function>pg_lo_tell</function> returns current position (offset
from the beginning of large object).
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_seek</function>.
<simplelist>
<member><function>pg_lo_seek</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-unlink">
<refnamediv>
<refname>pg_lo_unlink</refname>
<refpurpose>Delete a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_lo_unlink</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -26,9 +27,15 @@
This function used to be called <literal>pg_lo_unlink()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_create</function> and
<function>pg_lo_import</function>.
<simplelist>
<member><function>pg_lo_create</function></member>
<member><function>pg_lo_import</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-lo-write">
<refnamediv>
<refname>pg_lo_write</refname>
<refpurpose>Write a large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_lo_write</methodname>
<methodparam><type>resource</type><parameter>large_object</parameter></methodparam>
@ -30,9 +31,15 @@
This function used to be called <literal>pg_lowrite()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_lo_create</function> and
<function>pg_lo_open</function>.
<simplelist>
<member><function>pg_lo_create</function></member>
<member><function>pg_lo_open</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-meta-data'>
<refnamediv>
@ -8,8 +8,9 @@
Get meta data for table
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_meta_data</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -20,6 +21,11 @@
<literal>table_name</literal> as an array. If there is error, it
returns &false;
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting table metadata</title>
@ -37,9 +43,7 @@
?>
]]>
</programlisting>
<para>
The above example would produce the following output:
</para>
&example.outputs;
<screen>
<![CDATA[
array(3) {
@ -87,10 +91,15 @@ array(5) {
</screen>
</example>
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_convert</function>.
</para>
<simplelist>
<member><function>pg_convert</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-num-fields">
<refnamediv>
<refname>pg_num_fields</refname>
<refpurpose>Returns the number of fields</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_num_fields</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -24,9 +25,15 @@
This function used to be called <literal>pg_numfields()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_num_rows</function> and
<function>pg_affected_rows</function>.
<simplelist>
<member><function>pg_num_rows</function></member>
<member><function>pg_affected_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-num-rows">
<refnamediv>
<refname>pg_num_rows</refname>
<refpurpose>Returns the number of rows</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_num_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -30,9 +31,15 @@
This function used to be called <literal>pg_numrows()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_num_fields</function> and
<function>pg_affected_rows</function>.
<simplelist>
<member><function>pg_num_fields</function></member>
<member><function>pg_affected_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-options">
<refnamediv>
<refname>pg_options</refname>
<refpurpose>Get the options associated with the connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_options</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.pg-parameter-status">
<refnamediv>
<refname>pg_parameter_status</refname>
@ -7,8 +7,9 @@
Returns the value of a server parameter
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_parameter_status</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-pconnect">
<refnamediv>
<refname>pg_pconnect</refname>
<refpurpose>Open a persistent PostgreSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_pconnect</methodname>
<methodparam><type>string</type><parameter>connection_string</parameter></methodparam>
@ -37,10 +38,18 @@
<function>pg_close</function> will not close persistent links
generated by <function>pg_pconnect</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connect</function>, and the section
<link linkend="features.persistent-connections">Persistent Database
Connections</link> for more information.
<simplelist>
<member><function>pg_connect</function></member>
<member>
<link linkend="features.persistent-connections">
Persistent Database Connections</link>
</member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-ping">
<refnamediv>
<refname>pg_ping</refname>
<refpurpose>Ping database connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_ping</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -17,6 +18,10 @@
reconnect if it is broken. It returns &true; if connection is
alive, otherwise &false;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_ping</function> example</title>
@ -36,9 +41,15 @@ if (!pg_ping($conn))
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connection_status</function> and
<function>pg_connection_reset</function>.
<simplelist>
<member><function>pg_connection_status</function></member>
<member><function>pg_connection_reset</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.20 -->
<refentry id="function.pg-port">
<refnamediv>
@ -8,8 +8,9 @@
Return the port number associated with the connection
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_port</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.20 -->
<refentry id="function.pg-put-line">
<refnamediv>
<refname>pg_put_line</refname>
<refpurpose>Send a NULL-terminated string to PostgreSQL backend</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_put_line</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
@ -31,6 +32,19 @@
sending its data.
</para>
</note>
<warning>
<para>
Use of the <function>pg_put_line</function> causes most large object
operations, including <function>pg_lo_read</function> and
<function>pg_lo_tell</function>, to subsequently fail. You can use
<function>pg_copy_from</function> and <function>pg_copy_to</function>
instead.
</para>
</warning>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>High-speed insertion of data into a table</title>
@ -49,17 +63,14 @@
</programlisting>
</example>
</para>
<warning>
<para>
Use of the <function>pg_put_line</function> causes most large object
operations, including <function>pg_lo_read</function> and
<function>pg_lo_tell</function>, to subsequently fail. You can use
<function>pg_copy_from</function> and <function>pg_copy_to</function>
instead.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_end_copy</function>.
<simplelist>
<member><function>pg_end_copy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-query">
<refnamediv>
<refname>pg_query</refname>
<refpurpose>Execute a query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>pg_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
@ -55,13 +56,19 @@
reasons but users are encouraged to use the newer name.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connect</function>,
<function>pg_pconnect</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_object</function>,
<function>pg_num_rows</function> and
<function>pg_affected_rows</function>.
<simplelist>
<member><function>pg_connect</function></member>
<member><function>pg_pconnect</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_num_rows</function></member>
<member><function>pg_affected_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id='function.pg-result-error'>
<refnamediv>
@ -8,8 +8,9 @@
Get error message associated with result
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_result_error</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -25,13 +26,19 @@
you must use <function>pg_send_query</function> and
<function>pg_get_result</function> to get the result handle.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function>,
<function>pg_send_query</function>,
<function>pg_get_result</function>,
<function>pg_last_error</function> and
<function>pg_last_notice</function>
</para>
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_send_query</function></member>
<member><function>pg_get_result</function></member>
<member><function>pg_last_error</function></member>
<member><function>pg_last_notice</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id="function.pg-result-seek">
<refnamediv>
<refname>pg_result_seek</refname>
<refpurpose>Set internal row offset in result resource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_result_seek</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -17,12 +18,18 @@
<function>pg_result_seek</function> set internal row offset in
result resource. It returns &false;, if there is error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_fetch_row</function>,
<function>pg_fetch_assoc</function>,
<function>pg_fetch_array</function>,
<function>pg_fetch_object</function> and
<function>pg_fetch_result</function>.
<simplelist>
<member><function>pg_fetch_row</function></member>
<member><function>pg_fetch_assoc</function></member>
<member><function>pg_fetch_array</function></member>
<member><function>pg_fetch_object</function></member>
<member><function>pg_fetch_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
<refentry id='function.pg-result-status'>
<refnamediv>
@ -8,8 +8,9 @@
Get status of query result
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_result_status</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
@ -21,8 +22,14 @@
PGSQL_COPY_FROM, PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR and
PGSQL_FATAL_ERROR.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_connection_status</function>.
<simplelist>
<member><function>pg_connection_status</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-select'>
<refnamediv>
@ -8,8 +8,9 @@
Select records
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_select</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -27,6 +28,11 @@
<function>pg_convert</function> is applied to
<literal>assoc_array</literal> with specified option.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_select</function> example</title>
@ -47,10 +53,15 @@
</programlisting>
</example>
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_convert</function>
</para>
<simplelist>
<member><function>pg_convert</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
<refentry id='function.pg-send-query'>
<refnamediv>
@ -8,8 +8,9 @@
Sends asynchronous query
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_send_query</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -36,6 +37,10 @@
connection is busy, it waits until last query is finished and
discards all result.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Asynchronous Queries</title>
@ -60,9 +65,7 @@
?>
]]>
</programlisting>
<para>
The above example would produce the following output:
</para>
&example.outputs;
<screen>
<![CDATA[
first call to pg_get_result(): Resource id #3
@ -74,11 +77,17 @@ Resource id #4 has 1 records
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_query</function>,
<function>pg_cancel_query</function>,
<function>pg_get_result</function> and
<function>pg_connection_busy</function>.
<simplelist>
<member><function>pg_query</function></member>
<member><function>pg_cancel_query</function></member>
<member><function>pg_get_result</function></member>
<member><function>pg_connection_busy</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.16 -->
<refentry id="function.pg-set-client-encoding">
<refnamediv>
@ -8,8 +8,9 @@
Set the client encoding
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>pg_set_client_encoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
@ -42,8 +43,14 @@
<literal>pg_setclientencoding()</literal>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_client_encoding</function>.
<simplelist>
<member><function>pg_client_encoding</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.7 -->
<refentry id="function.pg-trace">
<refnamediv>
<refname>pg_trace</refname>
<refpurpose>Enable tracing a PostgreSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_trace</methodname>
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
@ -38,9 +39,15 @@
<parameter>pathname</parameter> could be opened for logging,
&false; otherwise.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>fopen</function> and
<function>pg_untrace</function>.
<simplelist>
<member><function>fopen</function></member>
<member><function>pg_untrace</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
<refentry id="function.pg-tty">
<refnamediv>
@ -8,8 +8,9 @@
Return the tty name associated with the connection
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_tty</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.61 -->
<refentry id='function.pg-unescape-bytea'>
<refnamediv>
@ -8,8 +8,9 @@
Unescape binary for bytea type
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>pg_unescape_bytea</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
@ -34,9 +35,15 @@
stream error. User must cast to bytea to avoid this error.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_escape_bytea</function> and
<function>pg_escape_string</function>
<simplelist>
<member><function>pg_escape_bytea</function></member>
<member><function>pg_escape_string</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,13 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.58 -->
<refentry id="function.pg-untrace">
<refnamediv>
<refname>pg_untrace</refname>
<refpurpose>Disable tracing of a PostgreSQL connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>pg_untrace</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>
@ -20,8 +21,14 @@
<para>
Returns always &true;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_trace</function>.
<simplelist>
<member><function>pg_trace</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.80 -->
<refentry id='function.pg-update'>
<refnamediv>
@ -8,8 +8,9 @@
Update table
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>pg_update</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
@ -25,6 +26,11 @@
<function>pg_convert</function> is applied to
<literal>data</literal> with specified options.
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>pg_update</function> example</title>
@ -46,10 +52,15 @@
</programlisting>
</example>
</para>
&warn.experimental.func;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>pg_convert</function>.
</para>
<simplelist>
<member><function>pg_convert</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.pg-version">
<refnamediv>
<refname>pg_version</refname>
@ -7,8 +7,9 @@
Returns an array with client, protocol and server version (when available)
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>pg_version</methodname>
<methodparam choice="opt"><type>resource</type><parameter>connection</parameter></methodparam>