<!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>Returns the current in-transaction status of the server.</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-trace.html">pg_trace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-tty.html">pg_tty</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-transaction-status" class="refentry">
<div class="refnamediv">
<h1 class="refname">pg_transaction_status</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">pg_transaction_status</span> — <span class="dc-title">Returns the current in-transaction status of the server.</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.pg-transaction-status-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>pg_transaction_status</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
)</div>
<p class="para rdfs-comment">
Returns the current in-transaction status of the server.
</p>
<div class="caution"><strong class="caution">Caution</strong>
<p class="para">
<span class="function"><strong>pg_transaction_status()</strong></span> will give incorrect results when using
a PostgreSQL 7.3 server that has the parameter <em>autocommit</em>
set to off. The server-side autocommit feature has been
deprecated and does not exist in later server versions.
</p>
</div>
</div>
<div class="refsect1 parameters" id="refsect1-function.pg-transaction-status-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
PostgreSQL database connection resource.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.pg-transaction-status-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">The status can be <strong><code>PGSQL_TRANSACTION_IDLE</code></strong> (currently idle),
<strong><code>PGSQL_TRANSACTION_ACTIVE</code></strong> (a command is in progress),
<strong><code>PGSQL_TRANSACTION_INTRANS</code></strong> (idle, in a valid transaction block),
or <strong><code>PGSQL_TRANSACTION_INERROR</code></strong> (idle, in a failed transaction block).
<strong><code>PGSQL_TRANSACTION_UNKNOWN</code></strong> is reported if the connection is bad.
<strong><code>PGSQL_TRANSACTION_ACTIVE</code></strong> is reported only when a query
has been sent to the server and not yet completed.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.pg-transaction-status-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2124">
<p><strong>Example #1 <span class="function"><strong>pg_transaction_status()</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 /> </span><span style="color: #0000BB">$stat </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_transaction_status</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$stat </span><span style="color: #007700">=== </span><span style="color: #0000BB">PGSQL_TRANSACTION_UNKNOWN</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Connection is bad'</span><span style="color: #007700">;<br /> } else if (</span><span style="color: #0000BB">$stat </span><span style="color: #007700">=== </span><span style="color: #0000BB">PGSQL_TRANSACTION_IDLE</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Connection is currently idle'</span><span style="color: #007700">;<br /> } else {<br /> echo </span><span style="color: #DD0000">'Connection is in a transaction state'</span><span style="color: #007700">;<br /> } <br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.pg-trace.html">pg_trace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.pg-tty.html">pg_tty</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>
