<!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>Drop collection index</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collection.createindex.html">Collection::createIndex</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.existsindatabase.html">Collection::existsInDatabase</a></div> <div class="up"><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mysql-xdevapi-collection.dropindex" class="refentry"> <div class="refnamediv"> <h1 class="refname">Collection::dropIndex</h1> <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Collection::dropIndex</span> — <span class="dc-title">Drop collection index</span></p> </div> <div class="refsect1 description" id="refsect1-mysql-xdevapi-collection.dropindex-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>mysql_xdevapi\Collection::dropIndex</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index_name</code></span> )</div> <p class="para rdfs-comment"> Drop a collection index. </p> <p class="para"> This operation does not yield an error if the index does not exist, but <strong><code>FALSE</code></strong> is returned in that case. </p> </div> <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collection.dropindex-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">index_name</code></dt> <dd> <p class="para"> Name of collection index to drop. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collection.dropindex-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <strong><code>TRUE</code></strong> if the DROP INDEX operation succeeded, otherwise <strong><code>FALSE</code></strong>. </p> </div> <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collection.dropindex-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-1984"> <p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\Collection::dropIndex()</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">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</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">$create </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// ...<br /><br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">getCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">createIndex</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'myindex'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}'<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// ...<br /><br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$collection</span><span style="color: #007700">-></span><span style="color: #0000BB">dropIndex</span><span style="color: #007700">(</span><span style="color: #DD0000">'myindex'</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">'An index named '</span><span style="color: #0000BB">myindex</span><span style="color: #DD0000">' was found, and dropped.'</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> An index named 'myindex' was found, and dropped. </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-collection.createindex.html">Collection::createIndex</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.existsindatabase.html">Collection::existsInDatabase</a></div> <div class="up"><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>