1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 330300 $ -->
<refentry xml:id="mongocollection.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoCollection::remove</refname>
<refpurpose>Remove records from this collection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool|array</type><methodname>MongoCollection::remove</methodname>
<methodparam choice="opt"><type>array</type><parameter>criteria</parameter><initializer>array()</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>array()</initializer></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>criteria</parameter>
</term>
<listitem>
<para>
Description of records to remove.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>
Options for remove.
<itemizedlist>
&mongo.writes.parameters.writeconcern;
<listitem>
<para>
<literal>"justOne"</literal>
</para>
<para>
Remove at most one record matching this criteria.
</para>
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array containing the status of the removal if the
<literal>"w"</literal> option is set. Otherwise, returns &true;.
</para>
<para>
Fields in the status array are described in the documentation for
<function>MongoCollection::insert</function>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>
The <parameter>options</parameter> parameter no longer accepts a boolean
to signify <literal>"justOne"</literal>. Instead, this now has to be
done with <literal>array('justOne' => true)</literal>.
</entry>
</row>
<row>
<entry>1.2.11</entry>
<entry>
Emits <constant>E_DEPRECATED</constant> when
<parameter>options</parameter> is <type>scalar</type>.
</entry>
</row>
<row>
<entry>1.2.0</entry>
<entry>Added <literal>"timeout"</literal> option.</entry>
</row>
<row>
<entry>1.0.11</entry>
<entry>
Disconnects on "not master" errors if <literal>"safe"</literal> is set.
</entry>
</row>
<row>
<entry>1.0.9</entry>
<entry>
<para>
Added ability to pass integers to the <literal>"safe"</literal> option,
which previously only accepted booleans.
</para>
<para>
Added <literal>"fsync"</literal> option.
</para>
<para>
The return type was changed to be an array containing error information
if the <literal>"safe"</literal> option is used. Otherwise, a boolean
is returned as before.
</para>
</entry>
</row>
<row>
<entry>1.0.5</entry>
<entry>
Changed second parameter to be an array of options. Pre-1.0.5, the
second parameter was a boolean indicating the <literal>"safe"</literal>
option.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoCollection::remove</function> with justOne example</title>
<programlisting role="php">
<![CDATA[
<?php
$radioactive = $db->radioactive;
// count how much more plutonium there is
$remaining = $radioactive->count(array('type' => 94));
$halflife = $remaining/2;
// remove half of it
while ($halflife > 0) {
$radioactive->remove(array('type' => 94), array("justOne" => true));
$halflife--;
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>MongoCollection::insert</function></member>
<member><function>MongoCollection::update</function></member>
<member>MongoDB core docs on <link xlink:href="&url.mongodb.dochub.remove;">remove</link>.</member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
