<!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>Deletes all documents matching the given query</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrclient.deletebyqueries.html">SolrClient::deleteByQueries</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrclient.destruct.html">SolrClient::__destruct</a></div> <div class="up"><a href="class.solrclient.html">SolrClient</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="solrclient.deletebyquery" class="refentry"> <div class="refnamediv"> <h1 class="refname">SolrClient::deleteByQuery</h1> <p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::deleteByQuery</span> — <span class="dc-title">Deletes all documents matching the given query</span></p> </div> <div class="refsect1 description" id="refsect1-solrclient.deletebyquery-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><a href="class.solrupdateresponse.html" class="type SolrUpdateResponse">SolrUpdateResponse</a></span> <span class="methodname"><strong>SolrClient::deleteByQuery</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$query</code></span> )</div> <p class="para rdfs-comment"> Deletes all documents matching the given query. </p> </div> <div class="refsect1 parameters" id="refsect1-solrclient.deletebyquery-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">query</code></em></span> <dd> <p class="para"> The query </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-solrclient.deletebyquery-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a SolrUpdateResponse on success and throws a SolrClientException on failure. </p> </div> <div class="refsect1 examples" id="refsect1-solrclient.deletebyquery-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4724"> <p><strong>Example #1 <span class="methodname"><strong>SolrQuery::deleteByQuery()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$options </span><span style="color: #007700">= array<br />(<br /> </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_HOSTNAME</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'login' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_USERNAME</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'password' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_PASSWORD</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'port' </span><span style="color: #007700">=> </span><span style="color: #0000BB">SOLR_SERVER_PORT</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrClient</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//This will erase the entire index<br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">deleteByQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">"*:*"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-></span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-solrclient.deletebyquery-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="solrclient.deletebyid.html" class="methodname" rel="rdfs-seeAlso">SolrClient::deleteById()</a> - Delete by Id</span></li> <li class="member"> <span class="methodname"><a href="solrclient.deletebyids.html" class="methodname" rel="rdfs-seeAlso">SolrClient::deleteByIds()</a> - Deletes by Ids</span></li> <li class="member"> <span class="methodname"><a href="solrclient.deletebyqueries.html" class="methodname" rel="rdfs-seeAlso">SolrClient::deleteByQueries()</a> - Removes all documents matching any of the queries</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="solrclient.deletebyqueries.html">SolrClient::deleteByQueries</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrclient.destruct.html">SolrClient::__destruct</a></div> <div class="up"><a href="class.solrclient.html">SolrClient</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>