<!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>Commits a transaction</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pdo.begintransaction.html">PDO::beginTransaction</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pdo.construct.html">PDO::__construct</a></div>
<div class="up"><a href="class.pdo.html">PDO</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pdo.commit" class="refentry">
<div class="refnamediv">
<h1 class="refname">PDO::commit</h1>
<p class="verinfo">(PHP 5 >= 5.1.0, PECL pdo >= 0.1.0)</p><p class="refpurpose"><span class="refname">PDO::commit</span> — <span class="dc-title">
Commits a transaction
</span></p>
</div>
<div class="refsect1 description" id="refsect1-pdo.commit-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>PDO::commit</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
Commits a transaction, returning the database connection to autocommit
mode until the next call to <span class="function"><a href="pdo.begintransaction.html" class="function">PDO::beginTransaction()</a></span>
starts a new transaction.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pdo.commit-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pdo.commit-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-916">
<p><strong>Example #1 Committing a basic transaction</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Begin a transaction, turning off autocommit */<br /></span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">beginTransaction</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Insert multiple records on an all-or-nothing basis */<br /></span><span style="color: #0000BB">$sql </span><span style="color: #007700">= </span><span style="color: #DD0000">'INSERT INTO fruit<br /> (name, colour, calories)<br /> VALUES (?, ?, ?)'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$sth </span><span style="color: #007700">= </span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$sql</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$fruits </span><span style="color: #007700">as </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$sth</span><span style="color: #007700">-></span><span style="color: #0000BB">execute</span><span style="color: #007700">(array(<br /> </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">-></span><span style="color: #0000BB">colour</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">-></span><span style="color: #0000BB">calories</span><span style="color: #007700">,<br /> ));<br />}<br /><br /></span><span style="color: #FF8000">/* Commit the changes */<br /></span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Database connection is now back in autocommit mode */<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-917">
<p><strong>Example #2 Committing a DDL transaction</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Begin a transaction, turning off autocommit */<br /></span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">beginTransaction</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Change the database schema */<br /></span><span style="color: #0000BB">$sth </span><span style="color: #007700">= </span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">exec</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP TABLE fruit"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Commit the changes */<br /></span><span style="color: #0000BB">$dbh</span><span style="color: #007700">-></span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* Database connection is now back in autocommit mode */<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
Not all databases will allow transactions to operate on DDL statements:
some will generate errors, whereas others (including MySQL) will
automatically commit the transaction after the first DDL statement has
been encountered.
</span>
</p></blockquote>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-pdo.commit-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="pdo.begintransaction.html" class="function" rel="rdfs-seeAlso">PDO::beginTransaction()</a> - Initiates a transaction</span></li>
<li class="member"> <span class="function"><a href="pdo.rollback.html" class="function" rel="rdfs-seeAlso">PDO::rollBack()</a> - Rolls back a transaction</span></li>
<li class="member"><a href="pdo.transactions.html" class="link">Transactions and auto-commit</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pdo.begintransaction.html">PDO::beginTransaction</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pdo.construct.html">PDO::__construct</a></div>
<div class="up"><a href="class.pdo.html">PDO</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
