<!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>Determines the verbosity of messages returned by pg_last_error
and pg_result_error</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-set-client-encoding.html">pg_set_client_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-socket.html">pg_socket</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.pg-set-error-verbosity" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_set_error_verbosity</h1>
<p class="verinfo">(PHP 5 >= 5.1.0, PHP 7)</p><p class="refpurpose"><span class="refname">pg_set_error_verbosity</span> — <span class="dc-title">
Determines the verbosity of messages returned by <span class="function"><a href="function.pg-last-error.html" class="function">pg_last_error()</a></span>
and <span class="function"><a href="function.pg-result-error.html" class="function">pg_result_error()</a></span>
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-set-error-verbosity-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pg_set_error_verbosity</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
], <span class="methodparam"><span class="type">int</span> <code class="parameter">$verbosity</code></span>
)</div>
<p class="para rdfs-comment">
Determines the verbosity of messages returned by <span class="function"><a href="function.pg-last-error.html" class="function">pg_last_error()</a></span>
and <span class="function"><a href="function.pg-result-error.html" class="function">pg_result_error()</a></span>.
</p>
<p class="para">
<span class="function"><strong>pg_set_error_verbosity()</strong></span> sets the verbosity mode, returning the connection's previous
setting. In <strong><code>PGSQL_ERRORS_TERSE</code></strong> mode, returned messages include severity, primary text, and
position only; this will normally fit on a single line. The default mode (<strong><code>PGSQL_ERRORS_DEFAULT</code></strong>)
produces messages that include the above plus any detail, hint, or context
fields (these may span multiple lines). The <strong><code>PGSQL_ERRORS_VERBOSE</code></strong> mode includes all available
fields. Changing the verbosity does not affect the messages available from
already-existing result objects, only subsequently-created ones.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-set-error-verbosity-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">connection</code></dt>
<dd>
<p class="para">
PostgreSQL database connection resource. When
<code class="parameter">connection</code> is not present, the default connection
is used. The default connection is the last connection made by
<span class="function"><a href="function.pg-connect.html" class="function">pg_connect()</a></span> or <span class="function"><a href="function.pg-pconnect.html" class="function">pg_pconnect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">verbosity</code></dt>
<dd>
<p class="para">
The required verbosity: <strong><code>PGSQL_ERRORS_TERSE</code></strong>,
<strong><code>PGSQL_ERRORS_DEFAULT</code></strong>
or <strong><code>PGSQL_ERRORS_VERBOSE</code></strong>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-set-error-verbosity-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The previous verbosity level: <strong><code>PGSQL_ERRORS_TERSE</code></strong>,
<strong><code>PGSQL_ERRORS_DEFAULT</code></strong>
or <strong><code>PGSQL_ERRORS_VERBOSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-set-error-verbosity-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2602">
<p><strong>Example #1 <span class="function"><strong>pg_set_error_verbosity()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=publisher"</span><span style="color: #007700">) or die(</span><span style="color: #DD0000">"Could not connect"</span><span style="color: #007700">);<br /><br /> if (!</span><span style="color: #0000BB">pg_connection_busy</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">pg_send_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"select * from doesnotexist;"</span><span style="color: #007700">);<br /> }<br /> <br /> </span><span style="color: #0000BB">pg_set_error_verbosity</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #0000BB">PGSQL_ERRORS_VERBOSE</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$res1 </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_get_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">);<br /> echo </span><span style="color: #0000BB">pg_result_error</span><span style="color: #007700">(</span><span style="color: #0000BB">$res1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.pg-set-error-verbosity-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.pg-last-error.html" class="function" rel="rdfs-seeAlso">pg_last_error()</a> - Get the last error message string of a connection</span></li>
<li class="member"><span class="function"><a href="function.pg-result-error.html" class="function" rel="rdfs-seeAlso">pg_result_error()</a> - Get error message associated with result</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-set-client-encoding.html">pg_set_client_encoding</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-socket.html">pg_socket</a></div>
<div class="up"><a href="ref.pgsql.html">PostgreSQL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
