Module: Mongo::Collection::View::Writable

Included in:
Mongo::Collection::View
Defined in:
lib/mongo/collection/view/writable.rb

Overview

Defines write related behaviour for collection view.

Since:

  • 2.0.0

Constant Summary

ARRAY_FILTERS =

The array filters field constant.

Since:

  • 2.5.0

'array_filters'.freeze

Instance Method Summary collapse

Instance Method Details

#delete_many(opts = {}) ⇒ Result

Remove documents from the collection.

Examples:

Remove multiple documents from the collection.

collection_view.delete_many

Parameters:

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :collation (Hash)

    The collation to use.

Returns:

  • (Result)

    The response from the database.

Since:

  • 2.0.0



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/mongo/collection/view/writable.rb', line 147

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

#delete_one(opts = {}) ⇒ Result

Remove a document from the collection.

Examples:

Remove a single document from the collection.

collection_view.delete_one

Parameters:

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :collation (Hash)

    The collation to use.

Returns:

  • (Result)

    The response from the database.

Since:

  • 2.0.0



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/mongo/collection/view/writable.rb', line 175

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

#find_one_and_delete(opts = {}) ⇒ BSON::Document?

Finds a single document in the database via findAndModify and deletes it, returning the original document.

Examples:

Find one document and delete it.

view.find_one_and_delete

Parameters:

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :collation (Hash)

    The collation to use.

Returns:

  • (BSON::Document, nil)

    The document, if found.

Since:

  • 2.0.0



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# File 'lib/mongo/collection/view/writable.rb', line 42

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

#find_one_and_replace(replacement, opts = {}) ⇒ BSON::Document

Finds a single document and replaces it.

Examples:

Find a document and replace it, returning the original.

view.find_one_and_replace({ name: 'test' }, :return_document => :before)

Find a document and replace it, returning the new document.

view.find_one_and_replace({ name: 'test' }, :return_document => :after)

Parameters:

  • replacement (BSON::Document)

    The replacement.

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :return_document (Symbol)

    Either :before or :after.

  • :upsert (true, false)

    Whether to upsert if the document doesn't exist.

  • :bypass_document_validation (true, false)

    Whether or not to skip document level validation.

  • :write_concern (Hash)

    The write concern options. Defaults to the collection's write concern.

  • :collation (Hash)

    The collation to use.

Returns:

  • (BSON::Document)

    The document.

Since:

  • 2.0.0



84
85
86
# File 'lib/mongo/collection/view/writable.rb', line 84

def find_one_and_replace(replacement, opts = {})
  find_one_and_update(replacement, opts)
end

#find_one_and_update(document, opts = {}) ⇒ BSON::Document

Finds a single document and updates it.

an update should apply.

Examples:

Find a document and update it, returning the original.

view.find_one_and_update({ "$set" => { name: 'test' }}, :return_document => :before)

Parameters:

  • document (BSON::Document)

    The updates.

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :return_document (Symbol)

    Either :before or :after.

  • :upsert (true, false)

    Whether to upsert if the document doesn't exist.

  • :bypass_document_validation (true, false)

    Whether or not to skip document level validation.

  • :write_concern (Hash)

    The write concern options. Defaults to the collection's write concern.

  • :collation (Hash)

    The collation to use.

  • :array_filters (Array)

    A set of filters specifying to which array elements

Returns:

  • (BSON::Document)

    The document.

Since:

  • 2.0.0



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
# File 'lib/mongo/collection/view/writable.rb', line 109

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

#replace_one(replacement, opts = {}) ⇒ Result

Replaces a single document in the database with the new document.

Examples:

Replace a single document.

collection_view.replace_one({ name: 'test' })

Parameters:

  • replacement (Hash)

    The replacement document.

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :upsert (true, false)

    Whether to upsert if the document doesn't exist.

  • :collation (Hash)

    The collation to use.

Returns:

  • (Result)

    The response from the database.

Since:

  • 2.0.0



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/mongo/collection/view/writable.rb', line 208

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_many(spec, opts = {}) ⇒ Result

Update documents in the collection.

Examples:

Update multiple documents in the collection.

collection_view.update_many('$set' => { name: 'test' })

Parameters:

  • spec (Hash)

    The update statement.

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :upsert (true, false)

    Whether to upsert if the document doesn't exist.

  • :collation (Hash)

    The collation to use.

  • :array_filters (Array)

    A set of filters specifying to which array elements an update should apply.

Returns:

  • (Result)

    The response from the database.

Since:

  • 2.0.0



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/mongo/collection/view/writable.rb', line 250

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_one(spec, opts = {}) ⇒ Result

Update a single document in the collection.

Examples:

Update a single document in the collection.

collection_view.update_one('$set' => { name: 'test' })

Parameters:

  • spec (Hash)

    The update statement.

  • opts (Hash) (defaults to: {})

    The options.

Options Hash (opts):

  • :upsert (true, false)

    Whether to upsert if the document doesn't exist.

  • :collation (Hash)

    The collation to use.

  • :array_filters (Array)

    A set of filters specifying to which array elements an update should apply.

Returns:

  • (Result)

    The response from the database.

Since:

  • 2.0.0



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/mongo/collection/view/writable.rb', line 288

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