From e5761ba392010c4c1a5c3eb3a16e942b91ee5b03 Mon Sep 17 00:00:00 2001 From: Christopher Kings-Lynne Date: Sun, 3 Apr 2005 07:27:30 +0000 Subject: [PATCH] # 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 --- reference/pgsql/functions/pg-execute.xml | 94 +++++++-------- .../pgsql/functions/pg-parameter-status.xml | 98 ++++++++-------- reference/pgsql/functions/pg-prepare.xml | 108 +++++++++--------- reference/pgsql/functions/pg-query-params.xml | 94 +++++++-------- .../pgsql/functions/pg-result-error-field.xml | 50 ++++---- reference/pgsql/functions/pg-send-execute.xml | 74 ++++++------ reference/pgsql/functions/pg-send-prepare.xml | 80 ++++++------- .../pgsql/functions/pg-send-query-params.xml | 82 ++++++------- .../functions/pg-set-error-verbosity.xml | 76 ++++++------ .../pgsql/functions/pg-transaction-status.xml | 38 +++--- 10 files changed, 397 insertions(+), 397 deletions(-) diff --git a/reference/pgsql/functions/pg-execute.xml b/reference/pgsql/functions/pg-execute.xml index d7c071e730..840dafabd2 100644 --- a/reference/pgsql/functions/pg-execute.xml +++ b/reference/pgsql/functions/pg-execute.xml @@ -1,5 +1,5 @@ - + @@ -16,70 +16,70 @@ arrayparams - 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. pg_execute is like pg_query_params, - 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. pg_execute 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. - The parameters are identical to pg_query_params, except that the name of a - prepared statement is given instead of a query string. + The parameters are identical to pg_query_params, except that the name of a + prepared statement is given instead of a query string. - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - stmtname + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + stmtname + + 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 pg_prepare, pg_send_prepare or a PREPARE SQL - command. - - - - - params + command. + + + + + params - + 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. - - - - - - - - - &reftitle.returnvalues; - - A query result resource on success, or &false; on failure. + must match the number of placeholders. + + + + + + + + + &reftitle.returnvalues; + + A query result resource on success, or &false; on failure. diff --git a/reference/pgsql/functions/pg-parameter-status.xml b/reference/pgsql/functions/pg-parameter-status.xml index 4637672213..7798881370 100644 --- a/reference/pgsql/functions/pg-parameter-status.xml +++ b/reference/pgsql/functions/pg-parameter-status.xml @@ -1,5 +1,5 @@ - + pg_parameter_status @@ -17,73 +17,73 @@ Looks up a current parameter setting of the server. - Certain parameter values are reported by the server automatically at - connection startup or whenever their values change. pg_parameter_status 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. pg_parameter_status 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. - Parameters reported as of PostgreSQL 8.0 include server_version, + Parameters reported as of PostgreSQL 8.0 include server_version, server_encoding, client_encoding, - is_superuser, session_authorization, + is_superuser, session_authorization, DateStyle, TimeZone, and integer_datetimes. - (server_encoding, TimeZone, and - integer_datetimes were not reported by releases before 8.0.) Note that + (server_encoding, TimeZone, and + integer_datetimes were not reported by releases before 8.0.) Note that server_version, server_encoding and integer_datetimes - cannot change after PostgreSQL startup. + cannot change after PostgreSQL startup. PostgreSQL 7.3 or lower servers do not report parameter settings, - pg_parameter_status + pg_parameter_status includes logic to obtain values for server_version and - client_encoding - anyway. Applications are encouraged to use pg_parameter_status rather than ad + client_encoding + anyway. Applications are encouraged to use pg_parameter_status rather than ad hoc code to determine these values. - On a pre-7.4 - PostgreSQL server, changing client_encoding via SET after connection startup will + On a pre-7.4 + PostgreSQL server, changing client_encoding via SET after connection startup will not be reflected by pg_parameter_status. - + - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - param_name + + &reftitle.parameters; + + + + connection + + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + param_name - Possible param_name values include server_version, + Possible param_name values include server_version, server_encoding, client_encoding, - is_superuser, session_authorization, + is_superuser, session_authorization, DateStyle, TimeZone, and integer_datetimes. - - - - - - - - &reftitle.returnvalues; - A &string; containing the value of the parameter, &false; on failure or invalid - param_name. + + + + + + + + &reftitle.returnvalues; + A string containing the value of the parameter, &false; on failure or invalid + param_name. @@ -100,11 +100,11 @@ ?> ]]> - &example.outputs; - + &example.outputs; + +Server encoding: SQL_ASCII +]]> diff --git a/reference/pgsql/functions/pg-prepare.xml b/reference/pgsql/functions/pg-prepare.xml index a47d86068d..cda37ede13 100644 --- a/reference/pgsql/functions/pg-prepare.xml +++ b/reference/pgsql/functions/pg-prepare.xml @@ -1,5 +1,5 @@ - + @@ -17,74 +17,74 @@ stringquery - pg_prepare creates a prepared statement for later execution with + pg_prepare creates a prepared statement for later execution with pg_execute or pg_send_execute. - 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. pg_prepare 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. - The function creates a prepared statement named stmtname from the query - string, which must contain a single SQL command. stmtname 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 query as $1, $2, etc. + The function creates a prepared statement named stmtname from the query + string, which must contain a single SQL command. stmtname 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 query as $1, $2, etc. - Prepared statements for use with pg_prepare can also be created by - executing SQL PREPARE statements. (But pg_prepare 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 DEALLOCATE + Prepared statements for use with pg_prepare can also be created by + executing SQL PREPARE statements. (But pg_prepare 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 DEALLOCATE statement can be used for that purpose. - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - stmtname + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + stmtname + + 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. - - - - - query + previously defined unnamed statement. + + + + + query - + 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. - - - - - - - - - &reftitle.returnvalues; - - A query result resource on success, or &false; on failure. - + (multiple statements separated by semi-colons are not allowed.) If any parameters + are used, they are referred to as $1, $2, etc. + + + + + + + + + &reftitle.returnvalues; + + A query result resource on success, or &false; on failure. + diff --git a/reference/pgsql/functions/pg-query-params.xml b/reference/pgsql/functions/pg-query-params.xml index 778177f206..a73e5432e7 100644 --- a/reference/pgsql/functions/pg-query-params.xml +++ b/reference/pgsql/functions/pg-query-params.xml @@ -1,5 +1,5 @@ - + @@ -21,71 +21,71 @@ pg_query_params is like pg_query, - but offers additional functionality: parameter + but offers additional functionality: parameter values can be specified separately from the command string proper. pg_query_params 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. If parameters are used, they are referred to in the query - string as $1, $2, etc. params specifies the actual values of the + string as $1, $2, etc. params specifies the actual values of the parameters. A &null; value in this array means the corresponding parameter is SQL - NULL. + NULL. The primary advantage of pg_query_params over pg_query - is that parameter values - may be separated from the query string, thus avoiding the need for tedious + is that parameter values + may be separated from the query string, thus avoiding the need for tedious and error-prone quoting and escaping. Unlike pg_query, - pg_query_params allows at - most one SQL command in the given string. (There can be semicolons in it, + pg_query_params allows at + most one SQL command in the given string. (There can be semicolons in it, but not more than one nonempty command.) - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - query + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + query + + 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. - - - - - params + (multiple statements separated by semi-colons are not allowed.) If any parameters + are used, they are referred to as $1, $2, etc. + + + + + params - + 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. - - - - - - - - - &reftitle.returnvalues; - - A query result resource on success, or &false; on failure. + must match the number of placeholders. + + + + + + + + + &reftitle.returnvalues; + + A query result resource on success, or &false; on failure. diff --git a/reference/pgsql/functions/pg-result-error-field.xml b/reference/pgsql/functions/pg-result-error-field.xml index 515331ac5d..ddf38d4785 100644 --- a/reference/pgsql/functions/pg-result-error-field.xml +++ b/reference/pgsql/functions/pg-result-error-field.xml @@ -1,5 +1,5 @@ - + @@ -27,21 +27,21 @@ - - &reftitle.parameters; - - - - result - - + + &reftitle.parameters; + + + + result + + A PostgreSQL query result resource from a previously executed - statement. - - - - - fieldcode + statement. + + + + + fieldcode Possible fieldcode values are: PGSQL_DIAG_SEVERITY, @@ -54,16 +54,16 @@ PGSQL_DIAG_SOURCE_LINE or PGSQL_DIAG_SOURCE_FUNCTION. - - - - - - - - &reftitle.returnvalues; - A &string; containing the contents of the error field, &null; if the field does not exist or &false; - on failure. + + + + + + + + &reftitle.returnvalues; + A string containing the contents of the error field, &null; if the field does not exist or &false; + on failure. diff --git a/reference/pgsql/functions/pg-send-execute.xml b/reference/pgsql/functions/pg-send-execute.xml index 442f5944bd..4cae1fb7d6 100644 --- a/reference/pgsql/functions/pg-send-execute.xml +++ b/reference/pgsql/functions/pg-send-execute.xml @@ -1,5 +1,5 @@ - + @@ -28,51 +28,51 @@ - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - stmtname + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + stmtname + + 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 pg_prepare, pg_send_prepare or a PREPARE SQL - command. - - - - - params + command. + + + + + params - + 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. - - - - - - - - - &reftitle.returnvalues; + must match the number of placeholders. + + + + + + + + + &reftitle.returnvalues; Returns &true; on success, &false; on failure. Use pg_get_result - to determine the query result. + to determine the query result. diff --git a/reference/pgsql/functions/pg-send-prepare.xml b/reference/pgsql/functions/pg-send-prepare.xml index 544bc3a540..bd97f87bb8 100644 --- a/reference/pgsql/functions/pg-send-prepare.xml +++ b/reference/pgsql/functions/pg-send-prepare.xml @@ -1,5 +1,5 @@ - + @@ -20,58 +20,58 @@ without waiting for completion. - This is an asynchronous version of pg_prepare: it returns &true; if it was able to - dispatch the request, and &false; if not. After a successful call, call - pg_get_result to determine whether the server successfully created the - prepared statement. The function's parameters are handled identically to + This is an asynchronous version of pg_prepare: it returns &true; if it was able to + dispatch the request, and &false; if not. After a successful call, call + pg_get_result to determine whether the server successfully created the + prepared statement. The function's parameters are handled identically to pg_prepare. Like pg_prepare, it will not work on pre-7.4 versions of PostgreSQL. - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - stmtname + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + stmtname + + 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. - - - - - query + previously defined unnamed statement. + + + + + query - + 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. - - - - - + (multiple statements separated by semi-colons are not allowed.) If any parameters + are used, they are referred to as $1, $2, etc. + + + + + - - &reftitle.returnvalues; + + &reftitle.returnvalues; Returns &true; on success, &false; on failure. Use pg_get_result - to determine the query result. + to determine the query result. diff --git a/reference/pgsql/functions/pg-send-query-params.xml b/reference/pgsql/functions/pg-send-query-params.xml index 011f2ffc9c..514832722b 100644 --- a/reference/pgsql/functions/pg-send-query-params.xml +++ b/reference/pgsql/functions/pg-send-query-params.xml @@ -1,5 +1,5 @@ - + @@ -20,55 +20,55 @@ waiting for the result(s). - This is equivalent to pg_send_query except that query - parameters can be specified separately from the - query string. The function's parameters are - handled identically to pg_query_params. Like - pg_query_params, it will not work on pre-7.4 PostgreSQL + This is equivalent to pg_send_query except that query + parameters can be specified separately from the + query string. The function's parameters are + handled identically to pg_query_params. Like + pg_query_params, it will not work on pre-7.4 PostgreSQL connections, and it allows only one command in the query string. - + - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. - - - - - query + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. + + + + + query + + 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. - - - - - params + (multiple statements separated by semi-colons are not allowed.) If any parameters + are used, they are referred to as $1, $2, etc. + + + + + params - + 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. - - - - - - - - - &reftitle.returnvalues; + must match the number of placeholders. + + + + + + + + + &reftitle.returnvalues; Returns &true; on success, &false; on failure. Use pg_get_result - to determine the query result. + to determine the query result. diff --git a/reference/pgsql/functions/pg-set-error-verbosity.xml b/reference/pgsql/functions/pg-set-error-verbosity.xml index 63c4710313..5c6483cfaf 100644 --- a/reference/pgsql/functions/pg-set-error-verbosity.xml +++ b/reference/pgsql/functions/pg-set-error-verbosity.xml @@ -1,5 +1,5 @@ - + @@ -22,52 +22,52 @@ and pg_result_error. - pg_set_error_verbosity sets the verbosity mode, returning the connection's previous - setting. In TERSE 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 VERBOSE mode includes all available - fields. Changing the verbosity does not affect the messages available from + pg_set_error_verbosity sets the verbosity mode, returning the connection's previous + setting. In TERSE 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 VERBOSE mode includes all available + fields. Changing the verbosity does not affect the messages available from already-existing result objects, only subsequently-created ones. - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. When - connection is not present, the default connection - is used. The default connection is the last connection made by - pg_connect or pg_pconnect. - - - - - verbosity + + &reftitle.parameters; + + + + connection - + + PostgreSQL database connection resource. When + connection is not present, the default connection + is used. The default connection is the last connection made by + pg_connect or pg_pconnect. + + + + + verbosity + + The required verbosity: PGSQL_ERRORS_TERSE, PGSQL_ERRORS_DEFAULT - or PGSQL_ERRORS_VERBOSE. - - - - - - - - - &reftitle.returnvalues; - + or PGSQL_ERRORS_VERBOSE. + + + + + + + + + &reftitle.returnvalues; + The previous verbosity level: PGSQL_ERRORS_TERSE, PGSQL_ERRORS_DEFAULT - or PGSQL_ERRORS_VERBOSE. - + or PGSQL_ERRORS_VERBOSE. + diff --git a/reference/pgsql/functions/pg-transaction-status.xml b/reference/pgsql/functions/pg-transaction-status.xml index 534afcea74..0bd8865c50 100644 --- a/reference/pgsql/functions/pg-transaction-status.xml +++ b/reference/pgsql/functions/pg-transaction-status.xml @@ -1,5 +1,5 @@ - + @@ -26,24 +26,24 @@ - - &reftitle.parameters; - - - - connection - - - PostgreSQL database connection resource. - - - - - - - - - &reftitle.returnvalues; + + &reftitle.parameters; + + + + connection + + + PostgreSQL database connection resource. + + + + + + + + + &reftitle.returnvalues; The status can be PGSQL_TRANSACTION_IDLE (currently idle), PGSQL_TRANSACTION_ACTIVE (a command is in progress), PGSQL_TRANSACTION_INTRANS (idle, in a valid transaction block),