mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
# Sorry. Fix CRLF line endings, and a few XML problems.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183468 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christopher Kings-Lynne
parent
c598ae36df
commit
e5761ba392
10 changed files with 397 additions and 397 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.pg-execute">
|
||||
<refnamediv>
|
||||
|
|
@ -16,70 +16,70 @@
|
|||
<methodparam><type>array</type><parameter>params</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Sends a request to execute a prepared statement with given parameters, and
|
||||
Sends a request to execute a prepared statement with given parameters, and
|
||||
waits for the result.
|
||||
</para>
|
||||
<para>
|
||||
<function>pg_execute</function> is like <function>pg_query_params</function>,
|
||||
but the command to be executed is
|
||||
specified by naming a previously-prepared statement, instead of giving a
|
||||
query string. This feature allows commands that will be used repeatedly to
|
||||
be parsed and planned just once, rather than each time they are executed.
|
||||
The statement must have been prepared previously in the current session.
|
||||
but the command to be executed is
|
||||
specified by naming a previously-prepared statement, instead of giving a
|
||||
query string. This feature allows commands that will be used repeatedly to
|
||||
be parsed and planned just once, rather than each time they are executed.
|
||||
The statement must have been prepared previously in the current session.
|
||||
<function>pg_execute</function> is supported only against PostgreSQL 7.4 or
|
||||
higher connections; it will fail when using earlier versions.
|
||||
higher connections; it will fail when using earlier versions.
|
||||
</para>
|
||||
<para>
|
||||
The parameters are identical to <function>pg_query_params</function>, except that the name of a
|
||||
prepared statement is given instead of a query string.
|
||||
The parameters are identical to <function>pg_query_params</function>, except that the name of a
|
||||
prepared statement is given instead of a query string.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the prepared statement to execute. if
|
||||
"" is specified, then the unnamed statement is executed. The name must have
|
||||
been previously prepared using <function>pg_prepare</function>,
|
||||
<function>pg_send_prepare</function> or a <literal>PREPARE</literal> SQL
|
||||
command.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
command.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
An array of parameter values to substitute for the $1, $2, etc. placeholders
|
||||
in the original prepared query string. The number of elements in the array
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.</para>
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- $Revision: 1.8 $ -->
|
||||
<refentry id="function.pg-parameter-status">
|
||||
<refnamediv>
|
||||
<refname>pg_parameter_status</refname>
|
||||
|
|
@ -17,73 +17,73 @@
|
|||
Looks up a current parameter setting of the server.
|
||||
</para>
|
||||
<para>
|
||||
Certain parameter values are reported by the server automatically at
|
||||
connection startup or whenever their values change. <function>pg_parameter_status</function> can be
|
||||
used to interrogate these settings. It returns the current value of a
|
||||
parameter if known, or &false; if the parameter is not known.
|
||||
Certain parameter values are reported by the server automatically at
|
||||
connection startup or whenever their values change. <function>pg_parameter_status</function> can be
|
||||
used to interrogate these settings. It returns the current value of a
|
||||
parameter if known, or &false; if the parameter is not known.
|
||||
</para>
|
||||
<para>
|
||||
Parameters reported as of PostgreSQL 8.0 include <literal>server_version</literal>,
|
||||
Parameters reported as of PostgreSQL 8.0 include <literal>server_version</literal>,
|
||||
<literal>server_encoding</literal>, <literal>client_encoding</literal>,
|
||||
<literal>is_superuser</literal>, <literal>session_authorization</literal>,
|
||||
<literal>is_superuser</literal>, <literal>session_authorization</literal>,
|
||||
<literal>DateStyle</literal>, <literal>TimeZone</literal>, and <literal>integer_datetimes</literal>.
|
||||
(<literal>server_encoding</literal>, <literal>TimeZone</literal>, and
|
||||
<literal>integer_datetimes</literal> were not reported by releases before 8.0.) Note that
|
||||
(<literal>server_encoding</literal>, <literal>TimeZone</literal>, and
|
||||
<literal>integer_datetimes</literal> were not reported by releases before 8.0.) Note that
|
||||
<literal>server_version</literal>, <literal>server_encoding</literal> and <literal>integer_datetimes</literal>
|
||||
cannot change after PostgreSQL startup.
|
||||
cannot change after PostgreSQL startup.
|
||||
</para>
|
||||
<para>
|
||||
PostgreSQL 7.3 or lower servers do not report parameter settings,
|
||||
<function>pg_parameter_status</function>
|
||||
<function>pg_parameter_status</function>
|
||||
includes logic to obtain values for <literal>server_version</literal> and
|
||||
<literal>client_encoding</literal>
|
||||
anyway. Applications are encouraged to use <function>pg_parameter_status</function> rather than ad
|
||||
<literal>client_encoding</literal>
|
||||
anyway. Applications are encouraged to use <function>pg_parameter_status</function> rather than ad
|
||||
hoc code to determine these values.
|
||||
</para>
|
||||
<caution>
|
||||
<para>
|
||||
On a pre-7.4
|
||||
PostgreSQL server, changing <literal>client_encoding</literal> via <literal>SET</literal> after connection startup will
|
||||
On a pre-7.4
|
||||
PostgreSQL server, changing <literal>client_encoding</literal> via <literal>SET</literal> after connection startup will
|
||||
not be reflected by <function>pg_parameter_status</function>.
|
||||
</para>
|
||||
</para>
|
||||
</caution>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>param_name</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>param_name</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Possible <parameter>param_name</parameter> values include <literal>server_version</literal>,
|
||||
Possible <parameter>param_name</parameter> values include <literal>server_version</literal>,
|
||||
<literal>server_encoding</literal>, <literal>client_encoding</literal>,
|
||||
<literal>is_superuser</literal>, <literal>session_authorization</literal>,
|
||||
<literal>is_superuser</literal>, <literal>session_authorization</literal>,
|
||||
<literal>DateStyle</literal>, <literal>TimeZone</literal>, and
|
||||
<literal>integer_datetimes</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>A &string; containing the value of the parameter, &false; on failure or invalid
|
||||
<param>param_name</param>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>A <type>string</type> containing the value of the parameter, &false; on failure or invalid
|
||||
<parameter>param_name</parameter>.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
@ -100,11 +100,11 @@
|
|||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Server encoding: SQL_ASCII
|
||||
]]>
|
||||
Server encoding: SQL_ASCII
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.pg-prepare">
|
||||
<refnamediv>
|
||||
|
|
@ -17,74 +17,74 @@
|
|||
<methodparam><type>string</type><parameter>query</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>pg_prepare</function> creates a prepared statement for later execution with
|
||||
<function>pg_prepare</function> creates a prepared statement for later execution with
|
||||
<function>pg_execute</function> or <function>pg_send_execute</function>.
|
||||
This feature allows commands that will be used repeatedly to
|
||||
be parsed and planned just once, rather than each time they are executed.
|
||||
This feature allows commands that will be used repeatedly to
|
||||
be parsed and planned just once, rather than each time they are executed.
|
||||
<function>pg_prepare</function> is supported only against PostgreSQL 7.4 or
|
||||
higher connections; it will fail when using earlier versions.
|
||||
higher connections; it will fail when using earlier versions.
|
||||
</para>
|
||||
<para>
|
||||
The function creates a prepared statement named <param>stmtname</param> from the <param>query</param>
|
||||
string, which must contain a single SQL command. <param>stmtname</param> may be "" to
|
||||
create an unnamed statement, in which case any pre-existing unnamed
|
||||
statement is automatically replaced; otherwise it is an error if the
|
||||
statement name is already defined in the current session. If any parameters
|
||||
are used, they are referred to in the <param>query</param> as $1, $2, etc.
|
||||
The function creates a prepared statement named <parameter>stmtname</parameter> from the <parameter>query</parameter>
|
||||
string, which must contain a single SQL command. <parameter>stmtname</parameter> may be "" to
|
||||
create an unnamed statement, in which case any pre-existing unnamed
|
||||
statement is automatically replaced; otherwise it is an error if the
|
||||
statement name is already defined in the current session. If any parameters
|
||||
are used, they are referred to in the <parameter>query</parameter> as $1, $2, etc.
|
||||
</para>
|
||||
<para>
|
||||
Prepared statements for use with <function>pg_prepare</function> can also be created by
|
||||
executing SQL <literal>PREPARE</literal> statements. (But <function>pg_prepare</function> is more flexible since it
|
||||
does not require parameter types to be pre-specified.) Also, although there
|
||||
is no PHP function for deleting a prepared statement, the SQL <litearl>DEALLOCATE</literal>
|
||||
Prepared statements for use with <function>pg_prepare</function> can also be created by
|
||||
executing SQL <literal>PREPARE</literal> statements. (But <function>pg_prepare</function> is more flexible since it
|
||||
does not require parameter types to be pre-specified.) Also, although there
|
||||
is no PHP function for deleting a prepared statement, the SQL <literal>DEALLOCATE</literal>
|
||||
statement can be used for that purpose.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name to give the prepared statement. Must be unique per-connection. If
|
||||
"" is specified, then an unnamed statement is created, overwriting any
|
||||
previously defined unnamed statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
previously defined unnamed statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
The parameterised SQL statement. Must contain only a single statement.
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.
|
||||
</para>
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.pg-query-params">
|
||||
<refnamediv>
|
||||
|
|
@ -21,71 +21,71 @@
|
|||
</para>
|
||||
<para>
|
||||
<function>pg_query_params</function> is like <function>pg_query</function>,
|
||||
but offers additional functionality: parameter
|
||||
but offers additional functionality: parameter
|
||||
values can be specified separately from the command string proper.
|
||||
<function>pg_query_params</function> is supported only against PostgreSQL 7.4 or
|
||||
higher connections; it will fail when using earlier versions.
|
||||
higher connections; it will fail when using earlier versions.
|
||||
</para>
|
||||
<para>
|
||||
If parameters are used, they are referred to in the <parameter>query</parameter>
|
||||
string as $1, $2, etc. <param>params</param> specifies the actual values of the
|
||||
string as $1, $2, etc. <parameter>params</parameter> specifies the actual values of the
|
||||
parameters. A &null; value in this array means the corresponding parameter is SQL
|
||||
<literal>NULL</literal>.
|
||||
<literal>NULL</literal>.
|
||||
</para>
|
||||
<para>
|
||||
The primary advantage of <function>pg_query_params</function> over <function>pg_query</function>
|
||||
is that parameter values
|
||||
may be separated from the <parameter>query</parameter> string, thus avoiding the need for tedious
|
||||
is that parameter values
|
||||
may be separated from the <parameter>query</parameter> string, thus avoiding the need for tedious
|
||||
and error-prone quoting and escaping. Unlike <function>pg_query</function>,
|
||||
<function>pg_query_params</function> allows at
|
||||
most one SQL command in the given string. (There can be semicolons in it,
|
||||
<function>pg_query_params</function> allows at
|
||||
most one SQL command in the given string. (There can be semicolons in it,
|
||||
but not more than one nonempty command.)
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameterised SQL statement. Must contain only a single statement.
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
An array of parameter values to substitute for the $1, $2, etc. placeholders
|
||||
in the original prepared query string. The number of elements in the array
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.</para>
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A query result resource on success, or &false; on failure.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -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-error-field'>
|
||||
<refnamediv>
|
||||
|
|
@ -27,21 +27,21 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>result</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>result</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A PostgreSQL query result resource from a previously executed
|
||||
statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>fieldcode</parameter></term>
|
||||
statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>fieldcode</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Possible <parameter>fieldcode</parameter> values are: <literal>PGSQL_DIAG_SEVERITY</literal>,
|
||||
|
|
@ -54,16 +54,16 @@
|
|||
<literal>PGSQL_DIAG_SOURCE_LINE</literal> or
|
||||
<literal>PGSQL_DIAG_SOURCE_FUNCTION</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>A &string; containing the contents of the error field, &null; if the field does not exist or &false;
|
||||
on failure.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<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="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.pg-send-execute">
|
||||
<refnamediv>
|
||||
|
|
@ -28,51 +28,51 @@
|
|||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name of the prepared statement to execute. if
|
||||
"" is specified, then the unnamed statement is executed. The name must have
|
||||
been previously prepared using <function>pg_prepare</function>,
|
||||
<function>pg_send_prepare</function> or a <literal>PREPARE</literal> SQL
|
||||
command.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
command.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
An array of parameter values to substitute for the $1, $2, etc. placeholders
|
||||
in the original prepared query string. The number of elements in the array
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>Returns &true; on success, &false; on failure. Use <function>pg_get_result</function>
|
||||
to determine the query result.</para>
|
||||
to determine the query result.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id="function.pg-send-prepare">
|
||||
<refnamediv>
|
||||
|
|
@ -20,58 +20,58 @@
|
|||
without waiting for completion.
|
||||
</para>
|
||||
<para>
|
||||
This is an asynchronous version of <function>pg_prepare</function>: it returns &true; if it was able to
|
||||
dispatch the request, and &false; if not. After a successful call, call
|
||||
<function>pg_get_result</function> to determine whether the server successfully created the
|
||||
prepared statement. The function's parameters are handled identically to
|
||||
This is an asynchronous version of <function>pg_prepare</function>: it returns &true; if it was able to
|
||||
dispatch the request, and &false; if not. After a successful call, call
|
||||
<function>pg_get_result</function> to determine whether the server successfully created the
|
||||
prepared statement. The function's parameters are handled identically to
|
||||
<function>pg_prepare</function>. Like <function>pg_prepare</function>, it will not work
|
||||
on pre-7.4 versions of PostgreSQL.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>stmtname</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The name to give the prepared statement. Must be unique per-connection. If
|
||||
"" is specified, then an unnamed statement is created, overwriting any
|
||||
previously defined unnamed statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
previously defined unnamed statement.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
The parameterised SQL statement. Must contain only a single statement.
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>Returns &true; on success, &false; on failure. Use <function>pg_get_result</function>
|
||||
to determine the query result.</para>
|
||||
to determine the query result.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.2 -->
|
||||
<refentry id='function.pg-send-query-params'>
|
||||
<refnamediv>
|
||||
|
|
@ -20,55 +20,55 @@
|
|||
waiting for the result(s).
|
||||
</para>
|
||||
<para>
|
||||
This is equivalent to <function>pg_send_query</function> except that query
|
||||
parameters can be specified separately from the
|
||||
<parameter>query</parameter> string. The function's parameters are
|
||||
handled identically to <function>pg_query_params</function>. Like
|
||||
<function>pg_query_params</function>, it will not work on pre-7.4 PostgreSQL
|
||||
This is equivalent to <function>pg_send_query</function> except that query
|
||||
parameters can be specified separately from the
|
||||
<parameter>query</parameter> string. The function's parameters are
|
||||
handled identically to <function>pg_query_params</function>. Like
|
||||
<function>pg_query_params</function>, it will not work on pre-7.4 PostgreSQL
|
||||
connections, and it allows only one command in the query string.
|
||||
</para>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>query</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The parameterised SQL statement. Must contain only a single statement.
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
(multiple statements separated by semi-colons are not allowed.) If any parameters
|
||||
are used, they are referred to as $1, $2, etc.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>params</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
An array of parameter values to substitute for the $1, $2, etc. placeholders
|
||||
in the original prepared query string. The number of elements in the array
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
must match the number of placeholders.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>Returns &true; on success, &false; on failure. Use <function>pg_get_result</function>
|
||||
to determine the query result.</para>
|
||||
to determine the query result.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.16 -->
|
||||
<refentry id="function.pg-set-error-verbosity">
|
||||
<refnamediv>
|
||||
|
|
@ -22,52 +22,52 @@
|
|||
and <function>pg_result_error</function>.
|
||||
</para>
|
||||
<para>
|
||||
<function>pg_set_error_verbosity</function> sets the verbosity mode, returning the connection's previous
|
||||
setting. In <literal>TERSE</literal> mode, returned messages include severity, primary text, and
|
||||
position only; this will normally fit on a single line. The default mode
|
||||
produces messages that include the above plus any detail, hint, or context
|
||||
fields (these may span multiple lines). The <literal>VERBOSE</literal> mode includes all available
|
||||
fields. Changing the verbosity does not affect the messages available from
|
||||
<function>pg_set_error_verbosity</function> sets the verbosity mode, returning the connection's previous
|
||||
setting. In <literal>TERSE</literal> mode, returned messages include severity, primary text, and
|
||||
position only; this will normally fit on a single line. The default mode
|
||||
produces messages that include the above plus any detail, hint, or context
|
||||
fields (these may span multiple lines). The <literal>VERBOSE</literal> mode includes all available
|
||||
fields. Changing the verbosity does not affect the messages available from
|
||||
already-existing result objects, only subsequently-created ones.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>verbosity</parameter></term>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<para>
|
||||
PostgreSQL database connection resource. When
|
||||
<parameter>connection</parameter> is not present, the default connection
|
||||
is used. The default connection is the last connection made by
|
||||
<function>pg_connect</function> or <function>pg_pconnect</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>verbosity</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The required verbosity: <literal>PGSQL_ERRORS_TERSE</literal>,
|
||||
<literal>PGSQL_ERRORS_DEFAULT</literal>
|
||||
or <literal>PGSQL_ERRORS_VERBOSE</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
or <literal>PGSQL_ERRORS_VERBOSE</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
The previous verbosity level: <literal>PGSQL_ERRORS_TERSE</literal>,
|
||||
<literal>PGSQL_ERRORS_DEFAULT</literal>
|
||||
or <literal>PGSQL_ERRORS_VERBOSE</literal>.
|
||||
</para>
|
||||
or <literal>PGSQL_ERRORS_VERBOSE</literal>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/pgsql.xml, last change in rev 1.82 -->
|
||||
<refentry id='function.pg_transaction_status'>
|
||||
<refnamediv>
|
||||
|
|
@ -26,24 +26,24 @@
|
|||
</caution>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>connection</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
PostgreSQL database connection resource.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>The status can be <literal>PGSQL_TRANSACTION_IDLE</literal> (currently idle),
|
||||
<literal>PGSQL_TRANSACTION_ACTIVE</literal> (a command is in progress),
|
||||
<literal>PGSQL_TRANSACTION_INTRANS</literal> (idle, in a valid transaction block),
|
||||
|
|
|
|||
Loading…
Reference in a new issue