<!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>Execute EXCLUSIVE LOCK</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-tableselect.limit.html">TableSelect::limit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-tableselect.lockshared.html">TableSelect::lockShared</a></div>
<div class="up"><a href="class.mysql-xdevapi-tableselect.html">mysql_xdevapi\TableSelect</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysql-xdevapi-tableselect.lockexclusive" class="refentry">
<div class="refnamediv">
<h1 class="refname">TableSelect::lockExclusive</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">TableSelect::lockExclusive</span> — <span class="dc-title">Execute EXCLUSIVE LOCK</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysql-xdevapi-tableselect.lockexclusive-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\TableSelect">mysql_xdevapi\TableSelect</span></span> <span class="methodname"><strong>mysql_xdevapi\TableSelect::lockExclusive</strong></span>
([ <span class="methodparam"><span class="type">integer</span> <code class="parameter">$lock_waiting_option</code></span>
] )</div>
<p class="para rdfs-comment">
Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysql-xdevapi-tableselect.lockexclusive-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">lock_waiting_option</code></dt>
<dd>
<p class="para">
The optional waiting option that defaults to <strong><code>MYSQLX_LOCK_DEFAULT</code></strong>.
Valid values are:
</p>
<ul class="itemizedlist">
<li class="listitem"><p class="para"><strong><code>MYSQLX_LOCK_DEFAULT</code></strong></p></li>
<li class="listitem"><p class="para"><strong><code>MYSQLX_LOCK_NOWAIT</code></strong></p></li>
<li class="listitem"><p class="para"><strong><code>MYSQLX_LOCK_SKIP_LOCKED</code></strong></p></li>
</ul>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-tableselect.lockexclusive-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
TableSelect object.
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysql-xdevapi-tableselect.lockexclusive-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2150">
<p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\TableSelect::lockExclusive()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$table </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">getTable</span><span style="color: #007700">(</span><span style="color: #DD0000">"names"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">startTransaction</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$table</span><span style="color: #007700">-></span><span style="color: #0000BB">select</span><span style="color: #007700">(</span><span style="color: #DD0000">'name'</span><span style="color: #007700">, </span><span style="color: #DD0000">'age'</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">lockExclusive</span><span style="color: #007700">(</span><span style="color: #0000BB">MYSQLX_LOCK_NOWAIT</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetchAll</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$row</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[0] => Array
(
[name] => John
[age] => 42
)
[1] => Array
(
[name] => Sam
[age] => 42
)
)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-tableselect.limit.html">TableSelect::limit</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-tableselect.lockshared.html">TableSelect::lockShared</a></div>
<div class="up"><a href="class.mysql-xdevapi-tableselect.html">mysql_xdevapi\TableSelect</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
