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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
# Copyright (C) 2014-2017 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Collection
class View
# Defines write related behaviour for collection view.
#
# @since 2.0.0
module Writable
# The array filters field constant.
#
# @since 2.5.0
ARRAY_FILTERS = 'array_filters'.freeze
# Finds a single document in the database via findAndModify and deletes
# it, returning the original document.
#
# @example Find one document and delete it.
# view.find_one_and_delete
#
# @param [ Hash ] opts The options.
#
# @option opts [ Hash ] :collation The collation to use.
#
# @return [ BSON::Document, nil ] The document, if found.
#
# @since 2.0.0
def find_one_and_delete(opts = {})
cmd = { :findandmodify => collection.name, :query => filter, :remove => true }
cmd[:fields] = projection if projection
cmd[:sort] = sort if sort
cmd[:maxTimeMS] = max_time_ms if max_time_ms
cmd[:writeConcern] = write_concern.options if write_concern
with_session(opts) do |session|
write_with_retry(session, write_concern) do |server, txn_num|
apply_collation!(cmd, server, opts)
Operation::Commands::Command.new(
:selector => cmd,
:db_name => database.name,
:session => session,
:txn_num => txn_num
).execute(server)
end
end.first['value']
end
# Finds a single document and replaces it.
#
# @example Find a document and replace it, returning the original.
# view.find_one_and_replace({ name: 'test' }, :return_document => :before)
#
# @example Find a document and replace it, returning the new document.
# view.find_one_and_replace({ name: 'test' }, :return_document => :after)
#
# @param [ BSON::Document ] replacement The replacement.
# @param [ Hash ] opts The options.
#
# @option opts [ Symbol ] :return_document Either :before or :after.
# @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
# @option opts [ true, false ] :bypass_document_validation Whether or
# not to skip document level validation.
# @option opts [ Hash ] :write_concern The write concern options.
# Defaults to the collection's write concern.
# @option opts [ Hash ] :collation The collation to use.
#
# @return [ BSON::Document ] The document.
#
# @since 2.0.0
def find_one_and_replace(replacement, opts = {})
find_one_and_update(replacement, opts)
end
# Finds a single document and updates it.
#
# @example Find a document and update it, returning the original.
# view.find_one_and_update({ "$set" => { name: 'test' }}, :return_document => :before)
#
# @param [ BSON::Document ] document The updates.
# @param [ Hash ] opts The options.
#
# @option opts [ Symbol ] :return_document Either :before or :after.
# @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
# @option opts [ true, false ] :bypass_document_validation Whether or
# not to skip document level validation.
# @option opts [ Hash ] :write_concern The write concern options.
# Defaults to the collection's write concern.
# @option opts [ Hash ] :collation The collation to use.
# @option opts [ Array ] :array_filters A set of filters specifying to which array elements
# an update should apply.
#
# @return [ BSON::Document ] The document.
#
# @since 2.0.0
def find_one_and_update(document, opts = {})
cmd = { :findandmodify => collection.name, :query => filter }
cmd[:update] = document
cmd[:fields] = projection if projection
cmd[:sort] = sort if sort
cmd[:new] = !!(opts[:return_document] && opts[:return_document] == :after)
cmd[:upsert] = opts[:upsert] if opts[:upsert]
cmd[:maxTimeMS] = max_time_ms if max_time_ms
cmd[:bypassDocumentValidation] = !!opts[:bypass_document_validation]
cmd[:writeConcern] = write_concern.options if write_concern
value = with_session(opts) do |session|
write_with_retry(session, write_concern) do |server, txn_num|
apply_collation!(cmd, server, opts)
apply_array_filters!(cmd, server, opts)
Operation::Commands::Command.new(
:selector => cmd,
:db_name => database.name,
:session => session,
:txn_num => txn_num
).execute(server)
end
end.first['value']
value unless value.nil? || value.empty?
end
# Remove documents from the collection.
#
# @example Remove multiple documents from the collection.
# collection_view.delete_many
#
# @param [ Hash ] opts The options.
#
# @option opts [ Hash ] :collation The collation to use.
#
# @return [ Result ] The response from the database.
#
# @since 2.0.0
def delete_many(opts = {})
delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
with_session(opts) do |session|
legacy_write_with_retry do |server|
apply_collation!(delete_doc, server, opts)
Operation::Write::Delete.new(
:delete => delete_doc,
:db_name => collection.database.name,
:coll_name => collection.name,
:write_concern => collection.write_concern,
:session => session
).execute(server)
end
end
end
# Remove a document from the collection.
#
# @example Remove a single document from the collection.
# collection_view.delete_one
#
# @param [ Hash ] opts The options.
#
# @option opts [ Hash ] :collation The collation to use.
#
# @return [ Result ] The response from the database.
#
# @since 2.0.0
def delete_one(opts = {})
delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
write_concern = collection.write_concern
with_session(opts) do |session|
write_with_retry(session, write_concern) do |server, txn_num|
apply_collation!(delete_doc, server, opts)
Operation::Write::Delete.new(
:delete => delete_doc,
:db_name => collection.database.name,
:coll_name => collection.name,
:write_concern => write_concern,
:session => session,
:txn_num => txn_num
).execute(server)
end
end
end
# Replaces a single document in the database with the new document.
#
# @example Replace a single document.
# collection_view.replace_one({ name: 'test' })
#
# @param [ Hash ] replacement The replacement document.
# @param [ Hash ] opts The options.
#
# @option opts [ true, false ] :upsert Whether to upsert if the
# document doesn't exist.
# @option opts [ Hash ] :collation The collation to use.
#
# @return [ Result ] The response from the database.
#
# @since 2.0.0
def replace_one(replacement, opts = {})
update_doc = { Operation::Q => filter,
Operation::U => replacement,
Operation::MULTI => false,
Operation::UPSERT => !!opts[:upsert]
}
write_concern = collection.write_concern
with_session(opts) do |session|
write_with_retry(session, write_concern) do |server, txn_num|
apply_collation!(update_doc, server, opts)
apply_array_filters!(update_doc, server, opts)
Operation::Write::Update.new(
:update => update_doc,
:db_name => collection.database.name,
:coll_name => collection.name,
:write_concern => write_concern,
:bypass_document_validation => !!opts[:bypass_document_validation],
:session => session,
:txn_num => txn_num
).execute(server)
end
end
end
# Update documents in the collection.
#
# @example Update multiple documents in the collection.
# collection_view.update_many('$set' => { name: 'test' })
#
# @param [ Hash ] spec The update statement.
# @param [ Hash ] opts The options.
#
# @option opts [ true, false ] :upsert Whether to upsert if the
# document doesn't exist.
# @option opts [ Hash ] :collation The collation to use.
# @option opts [ Array ] :array_filters A set of filters specifying to which array elements
# an update should apply.
#
# @return [ Result ] The response from the database.
#
# @since 2.0.0
def update_many(spec, opts = {})
update_doc = { Operation::Q => filter,
Operation::U => spec,
Operation::MULTI => true,
Operation::UPSERT => !!opts[:upsert] }
with_session(opts) do |session|
legacy_write_with_retry do |server|
apply_collation!(update_doc, server, opts)
apply_array_filters!(update_doc, server, opts)
Operation::Write::Update.new(
:update => update_doc,
:db_name => collection.database.name,
:coll_name => collection.name,
:write_concern => collection.write_concern,
:bypass_document_validation => !!opts[:bypass_document_validation],
:session => session
).execute(server)
end
end
end
# Update a single document in the collection.
#
# @example Update a single document in the collection.
# collection_view.update_one('$set' => { name: 'test' })
#
# @param [ Hash ] spec The update statement.
# @param [ Hash ] opts The options.
#
# @option opts [ true, false ] :upsert Whether to upsert if the
# document doesn't exist.
# @option opts [ Hash ] :collation The collation to use.
# @option opts [ Array ] :array_filters A set of filters specifying to which array elements
# an update should apply.
#
# @return [ Result ] The response from the database.
#
# @since 2.0.0
def update_one(spec, opts = {})
update_doc = { Operation::Q => filter,
Operation::U => spec,
Operation::MULTI => false,
Operation::UPSERT => !!opts[:upsert] }
write_concern = collection.write_concern
with_session(opts) do |session|
write_with_retry(session, write_concern) do |server, txn_num|
apply_collation!(update_doc, server, opts)
apply_array_filters!(update_doc, server, opts)
Operation::Write::Update.new(
:update => update_doc,
:db_name => collection.database.name,
:coll_name => collection.name,
:write_concern => write_concern,
:bypass_document_validation => !!opts[:bypass_document_validation],
:session => session,
:txn_num => txn_num
).execute(server)
end
end
end
private
def apply_array_filters!(doc, server, opts = {})
if filters = opts[:array_filters] || opts[ARRAY_FILTERS]
validate_array_filters!(server, filters)
doc[:arrayFilters] = filters
end
end
def validate_array_filters!(server, filters)
if filters && !server.features.array_filters_enabled?
raise Error::UnsupportedArrayFilters.new
end
end
end
end
end
end
|
