chriskl Sun Apr 3 05:51:52 2005 EDT
Modified files:
/phpdoc/en/reference/pgsql constants.xml
Log:
- Document all ext/pgsql constants.
http://cvs.php.net/diff.php/phpdoc/en/reference/pgsql/constants.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/pgsql/constants.xml
diff -u phpdoc/en/reference/pgsql/constants.xml:1.5
phpdoc/en/reference/pgsql/constants.xml:1.6
--- phpdoc/en/reference/pgsql/constants.xml:1.5 Sat Mar 26 03:08:34 2005
+++ phpdoc/en/reference/pgsql/constants.xml Sun Apr 3 05:51:51 2005
@@ -1,8 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<section id="pgsql.constants">
&reftitle.constants;
&extension.constants;
+
<variablelist>
<varlistentry>
<term>
@@ -11,7 +12,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_fetch_array</function>. Return an associative
array of field
+ names and values.
</simpara>
</listitem>
</varlistentry>
@@ -22,7 +24,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_fetch_array</function>. Return a numerically
indexed array of field
+ numbers and values.
</simpara>
</listitem>
</varlistentry>
@@ -33,7 +36,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_fetch_array</function>. Return an array of field
values
+ that is both numerically indexed (by field number) and associated (by
field name).
</simpara>
</listitem>
</varlistentry>
@@ -44,7 +48,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_connection_status</function> indicating that
the database
+ connection is in an invalid state.
</simpara>
</listitem>
</varlistentry>
@@ -55,7 +60,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_connection_status</function> indicating that
the database
+ connection is in a valid state.
</simpara>
</listitem>
</varlistentry>
@@ -66,7 +72,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_lo_seek</function>. Seek operation is to begin
+ from the start of the object.
</simpara>
</listitem>
</varlistentry>
@@ -77,7 +84,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_lo_seek</function>. Seek operation is to begin
+ from the current position.
</simpara>
</listitem>
</varlistentry>
@@ -88,29 +96,8 @@
</term>
<listitem>
<simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>PGSQL_ESCAPE_STRING</constant>
- (<type>integer</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>PGSQL_ESCAPE_BYTEA</constant>
- (<type>integer</type>)
- </term>
- <listitem>
- <simpara>
-
+ Passed to <function>pg_lo_seek</function>. Seek operation is to begin
+ from the end of the object.
</simpara>
</listitem>
</varlistentry>
@@ -121,7 +108,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. The string sent to the
server
+ was empty.
</simpara>
</listitem>
</varlistentry>
@@ -132,7 +120,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. Successful completion
of a
+ command returning no data.
</simpara>
</listitem>
</varlistentry>
@@ -143,7 +132,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. Successful completion
of a command
+ returning data (such as a <literal>SELECT</literal> or
<literal>SHOW</literal>).
</simpara>
</listitem>
</varlistentry>
@@ -154,7 +144,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. Copy Out (from server)
data
+ transfer started.
</simpara>
</listitem>
</varlistentry>
@@ -165,7 +156,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. Copy In (to server)
data
+ transfer started.
</simpara>
</listitem>
</varlistentry>
@@ -176,7 +168,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. The server's response
+ was not understood.
</simpara>
</listitem>
</varlistentry>
@@ -187,7 +180,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. A nonfatal error
+ (a notice or warning) occurred.
</simpara>
</listitem>
</varlistentry>
@@ -198,7 +192,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_result_status</function>. A fatal error
+ occurred.
</simpara>
</listitem>
</varlistentry>
@@ -209,7 +204,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_transaction_status</function>. Connection is
+ currently idle, not in a transaction.
</simpara>
</listitem>
</varlistentry>
@@ -220,7 +216,9 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_transaction_status</function>. A command
+ is in progress on the connection. A query has been sent via the
connection
+ and not yet completed.
</simpara>
</listitem>
</varlistentry>
@@ -231,7 +229,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_transaction_status</function>. The connection
+ is idle, in a transaction block.
</simpara>
</listitem>
</varlistentry>
@@ -242,7 +241,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_transaction_status</function>. The connection
+ is idle, in a failed transaction block.
</simpara>
</listitem>
</varlistentry>
@@ -253,7 +253,8 @@
</term>
<listitem>
<simpara>
-
+ Returned by <function>pg_transaction_status</function>. The connection
+ is bad.
</simpara>
</listitem>
</varlistentry>
@@ -264,7 +265,12 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The severity; the field contents are <literal>ERROR</literal>,
+ <literal>FATAL</literal>, or <literal>PANIC</literal> (in an error
message), or
+ <literal>WARNING</literal>, <literal>NOTICE</literal>,
<literal>DEBUG</literal>,
+ <literal>INFO</literal>, or <literal>LOG</literal> (in a notice message),
or a localized
+ translation of one of these. Always present.
</simpara>
</listitem>
</varlistentry>
@@ -275,7 +281,11 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The SQLSTATE code for the error. The SQLSTATE code identifies the type of
error
+ that has occurred; it can be used by front-end applications to perform
specific
+ operations (such as error handling) in response to a particular database
error.
+ This field is not localizable, and is always present.
</simpara>
</listitem>
</varlistentry>
@@ -286,7 +296,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The primary human-readable error message (typically one line). Always
present.
</simpara>
</listitem>
</varlistentry>
@@ -297,7 +308,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ Detail: an optional secondary error message carrying more detail about
the problem. May run to multiple lines.
</simpara>
</listitem>
</varlistentry>
@@ -308,7 +320,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ Hint: an optional suggestion what to do about the problem. This is
intended to differ from detail in that it
+ offers advice (potentially inappropriate) rather than hard facts. May run
to multiple lines.
</simpara>
</listitem>
</varlistentry>
@@ -319,7 +333,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ A string containing a decimal integer indicating an error cursor position
as an index into the original
+ statement string. The first character has index 1, and positions are
measured in characters not bytes.
</simpara>
</listitem>
</varlistentry>
@@ -330,7 +346,12 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ This is defined the same as the
<constant>PG_DIAG_STATEMENT_POSITION</constant> field, but
+ it is used when the cursor position refers to an internally generated
+ command rather than the one submitted by the client. The
+ <constant>PG_DIAG_INTERNAL_QUERY</constant> field will always appear when
this
+ field appears.
</simpara>
</listitem>
</varlistentry>
@@ -341,7 +362,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The text of a failed internally-generated command. This could be, for
example, a
+ SQL query issued by a PL/pgSQL function.
</simpara>
</listitem>
</varlistentry>
@@ -352,7 +375,11 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ An indication of the context in which the error occurred. Presently
+ this includes a call stack traceback of active procedural language
+ functions and internally-generated queries. The trace is one entry
+ per line, most recent first.
</simpara>
</listitem>
</varlistentry>
@@ -363,7 +390,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The file name of the PostgreSQL source-code location where the error
+ was reported.
</simpara>
</listitem>
</varlistentry>
@@ -374,7 +403,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The line number of the PostgreSQL source-code location where the
+ error was reported.
</simpara>
</listitem>
</varlistentry>
@@ -385,7 +416,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_error_field</function>.
+ The name of the PostgreSQL source-code function reporting the error.
</simpara>
</listitem>
</varlistentry>
@@ -397,7 +429,9 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_set_error_verbosity</function>.
+ Specified that returned messages include severity, primary text,
+ and position only; this will normally fit on a single line.
</simpara>
</listitem>
</varlistentry>
@@ -408,7 +442,10 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_set_error_verbosity</function>.
+ The default mode produces messages that include the above
+ plus any detail, hint, or context fields (these may span
+ multiple lines).
</simpara>
</listitem>
</varlistentry>
@@ -419,7 +456,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_set_error_verbosity</function>.
+ The verbose mode includes all available fields.
</simpara>
</listitem>
</varlistentry>
@@ -431,7 +469,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_status</function>. Indicates that
+ numerical result code is desired.
</simpara>
</listitem>
</varlistentry>
@@ -442,7 +481,8 @@
</term>
<listitem>
<simpara>
-
+ Passed to <function>pg_result_status</function>. Indicates that
+ textual result command tag is desired.
</simpara>
</listitem>
</varlistentry>
