<!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>Starts a transaction</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysqli.autocommit.html">mysqli::autocommit</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysqli.change-user.html">mysqli::change_user</a></div> <div class="up"><a href="class.mysqli.html">mysqli</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mysqli.begin-transaction" class="refentry"> <div class="refnamediv"> <h1 class="refname">mysqli::begin_transaction</h1> <h1 class="refname">mysqli_begin_transaction</h1> <p class="verinfo">(PHP 5 >= 5.5.0, PHP 7)</p><p class="refpurpose"><span class="refname">mysqli::begin_transaction</span> -- <span class="refname">mysqli_begin_transaction</span> — <span class="dc-title">Starts a transaction</span></p> </div> <div class="refsect1 description" id="refsect1-mysqli.begin-transaction-description"> <h3 class="title">Description</h3> <p class="para">Object oriented style (method):</p> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>mysqli::begin_transaction</strong></span> ([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> ]] )</div> <p class="para rdfs-comment">Procedural style:</p> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>mysqli_begin_transaction</strong></span> ( <span class="methodparam"><span class="type"><a href="class.mysqli.html" class="type mysqli">mysqli</a></span> <code class="parameter">$link</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> ]] )</div> <p class="para rdfs-comment"> Begins a transaction. Requires the InnoDB engine (it is enabled by default). For additional details about how MySQL transactions work, see <a href="http://dev.mysql.com/doc/mysql/en/commit.html" class="link external">» http://dev.mysql.com/doc/mysql/en/commit.html</a>. </p> </div> <div class="refsect1 parameters" id="refsect1-mysqli.begin-transaction-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter"> link</code></dt> <dd> <p class="para">Procedural style only: A link identifier returned by <span class="function"><a href="function.mysqli-connect.html" class="function">mysqli_connect()</a></span> or <span class="function"><a href="mysqli.init.html" class="function">mysqli_init()</a></span> </p></dd> <dt> <code class="parameter">flags</code></dt> <dd> <p class="para"> Valid flags are: </p> <ul class="itemizedlist"> <li class="listitem"> <p class="para"> <strong><code>MYSQLI_TRANS_START_READ_ONLY</code></strong>: Start the transaction as "START TRANSACTION READ ONLY". Requires MySQL 5.6 and above. </p> </li> <li class="listitem"> <p class="para"> <strong><code>MYSQLI_TRANS_START_READ_WRITE</code></strong>: Start the transaction as "START TRANSACTION READ WRITE". Requires MySQL 5.6 and above. </p> </li> <li class="listitem"> <p class="para"> <strong><code>MYSQLI_TRANS_START_WITH_CONSISTENT_SNAPSHOT</code></strong>: Start the transaction as "START TRANSACTION WITH CONSISTENT SNAPSHOT". </p> </li> </ul> </dd> <dt> <code class="parameter">name</code></dt> <dd> <p class="para"> Savepoint name for the transaction. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-mysqli.begin-transaction-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-mysqli.begin-transaction-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1867"> <p><strong>Example #1 <span class="methodname"><strong>$mysqli->begin_transaction()</strong></span> example</strong></p> <div class="example-contents"><p>Object oriented style</p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$mysqli </span><span style="color: #007700">= new </span><span style="color: #0000BB">mysqli</span><span style="color: #007700">(</span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"sakila"</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">connect_errno</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">connect_error</span><span style="color: #007700">);<br /> exit();<br />}<br /><br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">begin_transaction</span><span style="color: #007700">(</span><span style="color: #0000BB">MYSQLI_TRANS_START_READ_ONLY</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT first_name, last_name FROM actor"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>Procedural style</p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"sakila"</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">mysqli_connect_errno</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Connect failed: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">mysqli_connect_error</span><span style="color: #007700">());<br /> exit();<br />}<br /><br /></span><span style="color: #0000BB">mysqli_begin_transaction</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #0000BB">MYSQLI_TRANS_START_READ_ONLY</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT first_name, last_name FROM actor LIMIT 1"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mysqli_commit</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">mysqli_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-mysqli.begin-transaction-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><span class="function"><a href="mysqli.autocommit.html" class="function" rel="rdfs-seeAlso">mysqli_autocommit()</a> - Turns on or off auto-committing database modifications</span></li> <li class="member"><span class="function"><a href="mysqli.commit.html" class="function" rel="rdfs-seeAlso">mysqli_commit()</a> - Commits the current transaction</span></li> <li class="member"><span class="function"><a href="mysqli.rollback.html" class="function" rel="rdfs-seeAlso">mysqli_rollback()</a> - Rolls back current transaction</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="mysqli.autocommit.html">mysqli::autocommit</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysqli.change-user.html">mysqli::change_user</a></div> <div class="up"><a href="class.mysqli.html">mysqli</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>