From 728feed4d1a452e3edb07b2dc79fe68345e2e2d1 Mon Sep 17 00:00:00 2001 From: Christopher Kings-Lynne Date: Sun, 3 Apr 2005 09:51:51 +0000 Subject: [PATCH] - Document all ext/pgsql constants. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@183473 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/pgsql/constants.xml | 162 +++++++++++++++++++++------------- 1 file changed, 101 insertions(+), 61 deletions(-) diff --git a/reference/pgsql/constants.xml b/reference/pgsql/constants.xml index 789e2eded3..1f19807b9e 100644 --- a/reference/pgsql/constants.xml +++ b/reference/pgsql/constants.xml @@ -1,8 +1,9 @@ - +
&reftitle.constants; &extension.constants; + @@ -11,7 +12,8 @@ - + Passed to pg_fetch_array. Return an associative array of field + names and values. @@ -22,7 +24,8 @@ - + Passed to pg_fetch_array. Return a numerically indexed array of field + numbers and values. @@ -33,7 +36,8 @@ - + Passed to pg_fetch_array. Return an array of field values + that is both numerically indexed (by field number) and associated (by field name). @@ -44,7 +48,8 @@ - + Returned by pg_connection_status indicating that the database + connection is in an invalid state. @@ -55,7 +60,8 @@ - + Returned by pg_connection_status indicating that the database + connection is in a valid state. @@ -66,7 +72,8 @@ - + Passed to pg_lo_seek. Seek operation is to begin + from the start of the object. @@ -77,7 +84,8 @@ - + Passed to pg_lo_seek. Seek operation is to begin + from the current position. @@ -88,29 +96,8 @@ - - - - - - - PGSQL_ESCAPE_STRING - (integer) - - - - - - - - - - PGSQL_ESCAPE_BYTEA - (integer) - - - - + Passed to pg_lo_seek. Seek operation is to begin + from the end of the object. @@ -121,7 +108,8 @@ - + Returned by pg_result_status. The string sent to the server + was empty. @@ -132,7 +120,8 @@ - + Returned by pg_result_status. Successful completion of a + command returning no data. @@ -143,7 +132,8 @@ - + Returned by pg_result_status. Successful completion of a command + returning data (such as a SELECT or SHOW). @@ -154,7 +144,8 @@ - + Returned by pg_result_status. Copy Out (from server) data + transfer started. @@ -165,7 +156,8 @@ - + Returned by pg_result_status. Copy In (to server) data + transfer started. @@ -176,7 +168,8 @@ - + Returned by pg_result_status. The server's response + was not understood. @@ -187,7 +180,8 @@ - + Returned by pg_result_status. A nonfatal error + (a notice or warning) occurred. @@ -198,7 +192,8 @@ - + Returned by pg_result_status. A fatal error + occurred. @@ -209,7 +204,8 @@ - + Returned by pg_transaction_status. Connection is + currently idle, not in a transaction. @@ -220,7 +216,9 @@ - + Returned by pg_transaction_status. A command + is in progress on the connection. A query has been sent via the connection + and not yet completed. @@ -231,7 +229,8 @@ - + Returned by pg_transaction_status. The connection + is idle, in a transaction block. @@ -242,7 +241,8 @@ - + Returned by pg_transaction_status. The connection + is idle, in a failed transaction block. @@ -253,7 +253,8 @@ - + Returned by pg_transaction_status. The connection + is bad. @@ -264,7 +265,12 @@ - + Passed to pg_result_error_field. + The severity; the field contents are ERROR, + FATAL, or PANIC (in an error message), or + WARNING, NOTICE, DEBUG, + INFO, or LOG (in a notice message), or a localized + translation of one of these. Always present. @@ -275,7 +281,11 @@ - + Passed to pg_result_error_field. + 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. @@ -286,7 +296,8 @@ - + Passed to pg_result_error_field. + The primary human-readable error message (typically one line). Always present. @@ -297,7 +308,8 @@ - + Passed to pg_result_error_field. + Detail: an optional secondary error message carrying more detail about the problem. May run to multiple lines. @@ -308,7 +320,9 @@ - + Passed to pg_result_error_field. + 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. @@ -319,7 +333,9 @@ - + Passed to pg_result_error_field. + 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. @@ -330,7 +346,12 @@ - + Passed to pg_result_error_field. + This is defined the same as the PG_DIAG_STATEMENT_POSITION field, but + it is used when the cursor position refers to an internally generated + command rather than the one submitted by the client. The + PG_DIAG_INTERNAL_QUERY field will always appear when this + field appears. @@ -341,7 +362,9 @@ - + Passed to pg_result_error_field. + The text of a failed internally-generated command. This could be, for example, a + SQL query issued by a PL/pgSQL function. @@ -352,7 +375,11 @@ - + Passed to pg_result_error_field. + 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. @@ -363,7 +390,9 @@ - + Passed to pg_result_error_field. + The file name of the PostgreSQL source-code location where the error + was reported. @@ -374,7 +403,9 @@ - + Passed to pg_result_error_field. + The line number of the PostgreSQL source-code location where the + error was reported. @@ -385,7 +416,8 @@ - + Passed to pg_result_error_field. + The name of the PostgreSQL source-code function reporting the error. @@ -397,7 +429,9 @@ - + Passed to pg_set_error_verbosity. + Specified that returned messages include severity, primary text, + and position only; this will normally fit on a single line. @@ -408,7 +442,10 @@ - + Passed to pg_set_error_verbosity. + The default mode produces messages that include the above + plus any detail, hint, or context fields (these may span + multiple lines). @@ -419,7 +456,8 @@ - + Passed to pg_set_error_verbosity. + The verbose mode includes all available fields. @@ -431,7 +469,8 @@ - + Passed to pg_result_status. Indicates that + numerical result code is desired. @@ -442,7 +481,8 @@ - + Passed to pg_result_status. Indicates that + textual result command tag is desired.