<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Predefined Constants</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pgsql.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pgsql.examples.html">Examples</a></div>
<div class="up"><a href="book.pgsql.html">PostgreSQL</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pgsql.constants" class="appendix">
<h1>Predefined Constants</h1>
<p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
<dl>
<dt id="constant.pgsql-assoc">
<span class="term">
<strong><code>PGSQL_ASSOC</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-fetch-array.html" class="function">pg_fetch_array()</a></span>. Return an associative array of field
names and values.
</span>
</dd>
</dt>
<dt id="constant.pgsql-num">
<span class="term">
<strong><code>PGSQL_NUM</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-fetch-array.html" class="function">pg_fetch_array()</a></span>. Return a numerically indexed array of field
numbers and values.
</span>
</dd>
</dt>
<dt id="constant.pgsql-both">
<span class="term">
<strong><code>PGSQL_BOTH</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-fetch-array.html" class="function">pg_fetch_array()</a></span>. Return an array of field values
that is both numerically indexed (by field number) and associated (by field name).
</span>
</dd>
</dt>
<dt id="constant.pgsql-connect-force-new">
<span class="term">
<strong><code>PGSQL_CONNECT_FORCE_NEW</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-connect.html" class="function">pg_connect()</a></span> to force the creation of a new connection,
rather than re-using an existing identical connection.
</span>
</dd>
</dt>
<dt id="constant.pgsql-connection-bad">
<span class="term">
<strong><code>PGSQL_CONNECTION_BAD</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-connection-status.html" class="function">pg_connection_status()</a></span> indicating that the database
connection is in an invalid state.
</span>
</dd>
</dt>
<dt id="constant.pgsql-connection-ok">
<span class="term">
<strong><code>PGSQL_CONNECTION_OK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-connection-status.html" class="function">pg_connection_status()</a></span> indicating that the database
connection is in a valid state.
</span>
</dd>
</dt>
<dt id="constant.pgsql-seek-set">
<span class="term">
<strong><code>PGSQL_SEEK_SET</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-lo-seek.html" class="function">pg_lo_seek()</a></span>. Seek operation is to begin
from the start of the object.
</span>
</dd>
</dt>
<dt id="constant.pgsql-seek-cur">
<span class="term">
<strong><code>PGSQL_SEEK_CUR</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-lo-seek.html" class="function">pg_lo_seek()</a></span>. Seek operation is to begin
from the current position.
</span>
</dd>
</dt>
<dt id="constant.pgsql-seek-end">
<span class="term">
<strong><code>PGSQL_SEEK_END</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-lo-seek.html" class="function">pg_lo_seek()</a></span>. Seek operation is to begin
from the end of the object.
</span>
</dd>
</dt>
<dt id="constant.pgsql-empty-query">
<span class="term">
<strong><code>PGSQL_EMPTY_QUERY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. The string sent to the server
was empty.
</span>
</dd>
</dt>
<dt id="constant.pgsql-command-ok">
<span class="term">
<strong><code>PGSQL_COMMAND_OK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Successful completion of a
command returning no data.
</span>
</dd>
</dt>
<dt id="constant.pgsql-tuples-ok">
<span class="term">
<strong><code>PGSQL_TUPLES_OK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Successful completion of a command
returning data (such as a <em>SELECT</em> or <em>SHOW</em>).
</span>
</dd>
</dt>
<dt id="constant.pgsql-copy-out">
<span class="term">
<strong><code>PGSQL_COPY_OUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Copy Out (from server) data
transfer started.
</span>
</dd>
</dt>
<dt id="constant.pgsql-copy-in">
<span class="term">
<strong><code>PGSQL_COPY_IN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Copy In (to server) data
transfer started.
</span>
</dd>
</dt>
<dt id="constant.pgsql-bad-response">
<span class="term">
<strong><code>PGSQL_BAD_RESPONSE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. The server's response
was not understood.
</span>
</dd>
</dt>
<dt id="constant.pgsql-nonfatal-error">
<span class="term">
<strong><code>PGSQL_NONFATAL_ERROR</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. A nonfatal error
(a notice or warning) occurred.
</span>
</dd>
</dt>
<dt id="constant.pgsql-fatal-error">
<span class="term">
<strong><code>PGSQL_FATAL_ERROR</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. A fatal error
occurred.
</span>
</dd>
</dt>
<dt id="constant.pgsql-transaction-idle">
<span class="term">
<strong><code>PGSQL_TRANSACTION_IDLE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-transaction-status.html" class="function">pg_transaction_status()</a></span>. Connection is
currently idle, not in a transaction.
</span>
</dd>
</dt>
<dt id="constant.pgsql-transaction-active">
<span class="term">
<strong><code>PGSQL_TRANSACTION_ACTIVE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-transaction-status.html" class="function">pg_transaction_status()</a></span>. A command
is in progress on the connection. A query has been sent via the connection
and not yet completed.
</span>
</dd>
</dt>
<dt id="constant.pgsql-transaction-intrans">
<span class="term">
<strong><code>PGSQL_TRANSACTION_INTRANS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-transaction-status.html" class="function">pg_transaction_status()</a></span>. The connection
is idle, in a transaction block.
</span>
</dd>
</dt>
<dt id="constant.pgsql-transaction-inerror">
<span class="term">
<strong><code>PGSQL_TRANSACTION_INERROR</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-transaction-status.html" class="function">pg_transaction_status()</a></span>. The connection
is idle, in a failed transaction block.
</span>
</dd>
</dt>
<dt id="constant.pgsql-transaction-unknown">
<span class="term">
<strong><code>PGSQL_TRANSACTION_UNKNOWN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Returned by <span class="function"><a href="function.pg-transaction-status.html" class="function">pg_transaction_status()</a></span>. The connection
is bad.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-severity">
<span class="term">
<strong><code>PGSQL_DIAG_SEVERITY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The severity; the field contents are <em>ERROR</em>,
<em>FATAL</em>, or <em>PANIC</em> (in an error message), or
<em>WARNING</em>, <em>NOTICE</em>, <em>DEBUG</em>,
<em>INFO</em>, or <em>LOG</em> (in a notice message), or a localized
translation of one of these. Always present.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-sqlstate">
<span class="term">
<strong><code>PGSQL_DIAG_SQLSTATE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
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.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-message-primary">
<span class="term">
<strong><code>PGSQL_DIAG_MESSAGE_PRIMARY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The primary human-readable error message (typically one line). Always present.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-message-detail">
<span class="term">
<strong><code>PGSQL_DIAG_MESSAGE_DETAIL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
Detail: an optional secondary error message carrying more detail about the problem. May run to multiple lines.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-message-hint">
<span class="term">
<strong><code>PGSQL_DIAG_MESSAGE_HINT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
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.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-statement-position">
<span class="term">
<strong><code>PGSQL_DIAG_STATEMENT_POSITION</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
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.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-internal-position">
<span class="term">
<strong><code>PGSQL_DIAG_INTERNAL_POSITION</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
This is defined the same as the <strong><code>PG_DIAG_STATEMENT_POSITION</code></strong> field, but
it is used when the cursor position refers to an internally generated
command rather than the one submitted by the client. The
<strong><code>PG_DIAG_INTERNAL_QUERY</code></strong> field will always appear when this
field appears.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-internal-query">
<span class="term">
<strong><code>PGSQL_DIAG_INTERNAL_QUERY</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The text of a failed internally-generated command. This could be, for example, a
SQL query issued by a PL/pgSQL function.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-context">
<span class="term">
<strong><code>PGSQL_DIAG_CONTEXT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
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.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-source-file">
<span class="term">
<strong><code>PGSQL_DIAG_SOURCE_FILE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The file name of the PostgreSQL source-code location where the error
was reported.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-source-line">
<span class="term">
<strong><code>PGSQL_DIAG_SOURCE_LINE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The line number of the PostgreSQL source-code location where the
error was reported.
</span>
</dd>
</dt>
<dt id="constant.pgsql-diag-source-function">
<span class="term">
<strong><code>PGSQL_DIAG_SOURCE_FUNCTION</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-error-field.html" class="function">pg_result_error_field()</a></span>.
The name of the PostgreSQL source-code function reporting the error.
</span>
</dd>
</dt>
<dt id="constant.pgsql-errors-terse">
<span class="term">
<strong><code>PGSQL_ERRORS_TERSE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-set-error-verbosity.html" class="function">pg_set_error_verbosity()</a></span>.
Specified that returned messages include severity, primary text,
and position only; this will normally fit on a single line.
</span>
</dd>
</dt>
<dt id="constant.pgsql-errors-default">
<span class="term">
<strong><code>PGSQL_ERRORS_DEFAULT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-set-error-verbosity.html" class="function">pg_set_error_verbosity()</a></span>.
The default mode produces messages that include the above
plus any detail, hint, or context fields (these may span
multiple lines).
</span>
</dd>
</dt>
<dt id="constant.pgsql-errors-verbose">
<span class="term">
<strong><code>PGSQL_ERRORS_VERBOSE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-set-error-verbosity.html" class="function">pg_set_error_verbosity()</a></span>.
The verbose mode includes all available fields.
</span>
</dd>
</dt>
<dt id="constant.pgsql-status-long">
<span class="term">
<strong><code>PGSQL_STATUS_LONG</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Indicates that
numerical result code is desired.
</span>
</dd>
</dt>
<dt id="constant.pgsql-status-string">
<span class="term">
<strong><code>PGSQL_STATUS_STRING</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-result-status.html" class="function">pg_result_status()</a></span>. Indicates that
textual result command tag is desired.
</span>
</dd>
</dt>
<dt id="constant.pgsql-conv-ignore-default">
<span class="term">
<strong><code>PGSQL_CONV_IGNORE_DEFAULT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-convert.html" class="function">pg_convert()</a></span>.
Ignore default values in the table during conversion.
</span>
</dd>
</dt>
<dt id="constant.pgsql-conv-force-null">
<span class="term">
<strong><code>PGSQL_CONV_FORCE_NULL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-convert.html" class="function">pg_convert()</a></span>.
Use SQL <em>NULL</em> in place of an empty <span class="type"><a href="language.types.string.html" class="type string">string</a></span>.
</span>
</dd>
</dt>
<dt id="constant.pgsql-conv-ignore-not-null">
<span class="term">
<strong><code>PGSQL_CONV_IGNORE_NOT_NULL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</span>
<dd>
<span class="simpara">
Passed to <span class="function"><a href="function.pg-convert.html" class="function">pg_convert()</a></span>.
Ignore conversion of <strong><code>NULL</code></strong> into SQL <em>NOT NULL</em> columns.
</span>
</dd>
</dt>
</dl>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pgsql.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pgsql.examples.html">Examples</a></div>
<div class="up"><a href="book.pgsql.html">PostgreSQL</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
