module Mongo::Collection::View::Writable

Defines write related behaviour for collection view.

@since 2.0.0

Constants

ARRAY_FILTERS

The array filters field constant.

@since 2.5.0

Public Instance Methods

delete_many(opts = {}) click to toggle source

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

# 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::Delete.new(
          :deletes => [ 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 = {}) click to toggle source

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

# 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::Delete.new(
          :deletes => [ 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 = {}) click to toggle source

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

# 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::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 = {}) click to toggle source

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

# 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 = {}) click to toggle source

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

# 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::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 = {}) click to toggle source

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

# 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::Update.new(
          :updates => [ 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 = {}) click to toggle source

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

# 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::Update.new(
          :updates => [ 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 = {}) click to toggle source

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

# 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::Update.new(
          :updates => [ 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 Instance Methods

apply_array_filters!(doc, server, opts = {}) click to toggle source
# File lib/mongo/collection/view/writable.rb, line 314
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
validate_array_filters!(server, filters) click to toggle source
# File lib/mongo/collection/view/writable.rb, line 321
def validate_array_filters!(server, filters)
  if filters && !server.features.array_filters_enabled?
    raise Error::UnsupportedArrayFilters.new
  end
end