<!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>Remove records from this collection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocollection.insert.html">MongoCollection::insert</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.save.html">MongoCollection::save</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongocollection.remove" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoCollection::remove</h1>
<p class="verinfo">(PECL mongo >=0.9.0)</p><p class="refpurpose"><span class="refname">MongoCollection::remove</span> — <span class="dc-title">Remove records from this collection</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongocollection.remove-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type bool|array">bool|array</span></span> <span class="methodname"><strong>MongoCollection::remove</strong></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$criteria</code><span class="initializer"> = array()</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span>
]] )</div>
</div>
<div class="refsect1 parameters" id="refsect1-mongocollection.remove-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term">
<em><code class="parameter">criteria</code></em>
</span>
<dd>
<p class="para">
Description of records to remove.
</p>
</dd>
</dt>
<dt>
<span class="term">
<em><code class="parameter">options</code></em>
</span>
<dd>
<p class="para">
Options for remove.
<ul class="itemizedlist">
<li class="listitem"><p class="para"><em>"w"</em></p><p class="para">See <a href="mongo.writeconcerns.html" class="link">WriteConcerns</a>. The default value for <a href="class.mongoclient.html" class="classname">MongoClient</a> is <em>1</em>.</p></li>
<li class="listitem">
<p class="para">
<em>"justOne"</em>
</p>
<p class="para">
Remove at most one record matching this criteria.
</p>
</li>
<li class="listitem"><p class="para"><em>"fsync"</em></p><p class="para">Boolean, defaults to <strong><code>FALSE</code></strong>. If journalling is enabled, it works exactly like <em>"j"</em>. If journalling is not enabled, it forces the insert to be synced to disk before returning success. If <strong><code>TRUE</code></strong>, an acknowledged insert is implied and will override setting <em>w</em> to <em>0</em>.</p><blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This option is <em class="emphasis">deprecated</em>. Please use the <em>"j"</em> option instead.</p></p></blockquote></li>
<li class="listitem"><p class="para"><em>"j"</em></p><p class="para">Boolean, defaults to <strong><code>FALSE</code></strong>. Forces the insert to be synced to the journal before returning success. If <strong><code>TRUE</code></strong>, an acknowledged insert is implied and will override setting <em>w</em> to <em>0</em>.</p></li>
<li class="listitem"><p class="para"><em>"w"</em></p><p class="para">See <a href="mongo.writeconcerns.html" class="link">WriteConcerns</a>. The default value for <a href="class.mongoclient.html" class="classname">MongoClient</a> is <em>1</em>.</p></li>
<li class="listitem"><p class="para"><em>"wtimeout"</em></p><p class="para">How long to wait for <a href="mongo.writeconcerns.html" class="link">WriteConcern</a> acknowledgement. The default value for <a href="class.mongoclient.html" class="classname">MongoClient</a> is <em>10000</em> milliseconds.</p></li>
<li class="listitem"><p class="para"><em>"safe"</em></p><p class="para"><em class="emphasis">Deprecated</em>. Please use the <a href="mongo.writeconcerns.html" class="link">WriteConcern</a> <em>w</em> option.</p></li>
<li class="listitem"><p class="para"><em>"timeout"</em></p><p class="para">Integer, defaults to <em>MongoCursor::$timeout</em>. If acknowledged writes are used, this sets how long (in milliseconds) for the client to wait for a database response. If the database does not respond within the timeout period, a <a href="class.mongocursortimeoutexception.html" class="classname">MongoCursorTimeoutException</a> will be thrown.</p></li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongocollection.remove-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array containing the status of the removal if the
<em>"w"</em> option is set. Otherwise, returns <strong><code>TRUE</code></strong>.
</p>
<p class="para">
Fields in the status array are described in the documentation for
<span class="function"><a href="mongocollection.insert.html" class="function">MongoCollection::insert()</a></span>.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongocollection.remove-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws <a href="class.mongocursorexception.html" class="classname">MongoCursorException</a> if the "w" option is set and the write fails.</p><p class="para">Throws <a href="class.mongocursortimeoutexception.html" class="classname">MongoCursorTimeoutException</a> if the "w" option is set to a value greater than one and the operation takes longer than <var class="varname"><var class="varname">MongoCursor::$timeout</var></var> milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in <em>MongoCollection::$wtimeout</em> is milliseconds.</p>
</div>
<div class="refsect1 changelog" id="refsect1-mongocollection.remove-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1.3.0</td>
<td>
The <em><code class="parameter">options</code></em> parameter no longer accepts a boolean
to signify <em>"justOne"</em>. Instead, this now has to be
done with <em>array('justOne' => true)</em>.
</td>
</tr>
<tr>
<td>1.2.11</td>
<td>
Emits <strong><code>E_DEPRECATED</code></strong> when
<em><code class="parameter">options</code></em> is <span class="type"><span class="type scalar">scalar</span></span>.
</td>
</tr>
<tr>
<td>1.2.0</td>
<td>Added <em>"timeout"</em> option.</td>
</tr>
<tr>
<td>1.0.11</td>
<td>
Disconnects on "not master" errors if <em>"safe"</em> is set.
</td>
</tr>
<tr>
<td>1.0.9</td>
<td>
<p class="para">
Added ability to pass integers to the <em>"safe"</em> option,
which previously only accepted booleans.
</p>
<p class="para">
Added <em>"fsync"</em> option.
</p>
<p class="para">
The return type was changed to be an array containing error information
if the <em>"safe"</em> option is used. Otherwise, a boolean
is returned as before.
</p>
</td>
</tr>
<tr>
<td>1.0.5</td>
<td>
Changed second parameter to be an array of options. Pre-1.0.5, the
second parameter was a boolean indicating the <em>"safe"</em>
option.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-mongocollection.remove-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1464">
<p><strong>Example #1 <span class="function"><strong>MongoCollection::remove()</strong></span> with justOne example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$radioactive </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-></span><span style="color: #0000BB">radioactive</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// count how much more plutonium there is<br /></span><span style="color: #0000BB">$remaining </span><span style="color: #007700">= </span><span style="color: #0000BB">$radioactive</span><span style="color: #007700">-></span><span style="color: #0000BB">count</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'type' </span><span style="color: #007700">=> </span><span style="color: #0000BB">94</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$halflife </span><span style="color: #007700">= </span><span style="color: #0000BB">$remaining</span><span style="color: #007700">/</span><span style="color: #0000BB">2</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// remove half of it<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$halflife </span><span style="color: #007700">> </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$radioactive</span><span style="color: #007700">-></span><span style="color: #0000BB">remove</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'type' </span><span style="color: #007700">=> </span><span style="color: #0000BB">94</span><span style="color: #007700">), array(</span><span style="color: #DD0000">"justOne" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$halflife</span><span style="color: #007700">--;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongocollection.remove-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="function"><a href="mongocollection.insert.html" class="function" rel="rdfs-seeAlso">MongoCollection::insert()</a> - Inserts a document into the collection</span></li>
<li class="member"> <span class="function"><a href="mongocollection.update.html" class="function" rel="rdfs-seeAlso">MongoCollection::update()</a> - Update records based on a given criteria</span></li>
<li class="member">MongoDB core docs on <a href="docs.mongodb.org/manual/tutorial/remove-documents/" class="link external">» remove</a>.</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongocollection.insert.html">MongoCollection::insert</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongocollection.save.html">MongoCollection::save</a></div>
<div class="up"><a href="class.mongocollection.html">MongoCollection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
