<!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 or sets the AUTOCOMMIT state for a database connection</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.db2-bind-param.html">db2_bind_param</a></div> <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.db2-autocommit" class="refentry"> <div class="refnamediv"> <h1 class="refname">db2_autocommit</h1> <p class="verinfo">(PECL ibm_db2 >= 1.0.0)</p><p class="refpurpose"><span class="refname">db2_autocommit</span> — <span class="dc-title"> Returns or sets the AUTOCOMMIT state for a database connection </span></p> </div> <div class="refsect1 description" id="refsect1-function.db2-autocommit-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>db2_autocommit</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$value</code></span> ] )</div> <p class="para rdfs-comment"> Sets or gets the AUTOCOMMIT behavior of the specified connection resource. </p> </div> <div class="refsect1 parameters" id="refsect1-function.db2-autocommit-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"> A valid database connection resource variable as returned from <span class="function"><a href="function.db2-connect.html" class="function">db2_connect()</a></span> or <span class="function"><a href="function.db2-pconnect.html" class="function">db2_pconnect()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">value</code></em></span> <dd> <p class="para"> One of the following constants: <dl> <dt> <span class="term"><em>DB2_AUTOCOMMIT_OFF</em></span> <dd> <p class="para"> Turns AUTOCOMMIT off. </p> </dd> </dt> <dt> <span class="term"><em>DB2_AUTOCOMMIT_ON</em></span> <dd> <p class="para"> Turns AUTOCOMMIT on. </p> </dd> </dt> </dl> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.db2-autocommit-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> When <span class="function"><strong>db2_autocommit()</strong></span> receives only the <em><code class="parameter">connection</code></em> parameter, it returns the current state of AUTOCOMMIT for the requested connection as an integer value. A value of 0 indicates that AUTOCOMMIT is off, while a value of 1 indicates that AUTOCOMMIT is on. </p> <p class="para"> When <span class="function"><strong>db2_autocommit()</strong></span> receives both the <em><code class="parameter">connection</code></em> parameter and <em><code class="parameter">autocommit</code></em> parameter, it attempts to set the AUTOCOMMIT state of the requested connection to the corresponding state. Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.db2-autocommit-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-1138"> <p><strong>Example #1 Retrieving the AUTOCOMMIT value for a connection</strong></p> <div class="example-contents"><p> In the following example, a connection which has been created with AUTOCOMMIT turned off is tested with the <span class="function"><strong>db2_autocommit()</strong></span> function. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$options </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'autocommit' </span><span style="color: #007700">=> </span><span style="color: #0000BB">DB2_AUTOCOMMIT_OFF</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$ac </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_autocommit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$ac </span><span style="color: #007700">== </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> print </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$ac</span><span style="color: #DD0000"> -- AUTOCOMMIT is off."</span><span style="color: #007700">;<br />} else {<br /> print </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$ac</span><span style="color: #DD0000"> -- AUTOCOMMIT is on."</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 0 -- AUTOCOMMIT is off. </pre></div> </div> </div> <div class="example" id="example-1139"> <p><strong>Example #2 Setting the AUTOCOMMIT value for a connection</strong></p> <div class="example-contents"><p> In the following example, a connection which was initially created with AUTOCOMMIT turned off has its behavior changed to turn AUTOCOMMIT on. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$options </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'autocommit' </span><span style="color: #007700">=> </span><span style="color: #0000BB">DB2_AUTOCOMMIT_OFF</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$database</span><span style="color: #007700">, </span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Turn AUTOCOMMIT on<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_autocommit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">DB2_AUTOCOMMIT_ON</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rc</span><span style="color: #007700">) {<br /> print </span><span style="color: #DD0000">"Turning AUTOCOMMIT on succeeded.\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Check AUTOCOMMIT state<br /></span><span style="color: #0000BB">$ac </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_autocommit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$ac </span><span style="color: #007700">== </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> print </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$ac</span><span style="color: #DD0000"> -- AUTOCOMMIT is off."</span><span style="color: #007700">;<br />} else {<br /> print </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$ac</span><span style="color: #DD0000"> -- AUTOCOMMIT is on."</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> Turning AUTOCOMMIT on succeeded. 1 -- AUTOCOMMIT is on. </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.db2-autocommit-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.db2-connect.html" class="function" rel="rdfs-seeAlso">db2_connect()</a> - Returns a connection to a database</span></li> <li class="member"> <span class="function"><a href="function.db2-pconnect.html" class="function" rel="rdfs-seeAlso">db2_pconnect()</a> - Returns a persistent connection to a database</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="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.db2-bind-param.html">db2_bind_param</a></div> <div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>