module Mongo::Collection::View::Writable

Defines write related behavior 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. @option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@option opts [ Hash ] :write_concern The write concern options.

Can be :w => Integer, :fsync => Boolean, :j => Boolean.

@return [ Result ] The response from the database.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 181
def delete_many(opts = {})
  QueryCache.clear_namespace(collection.namespace)

  delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
  with_session(opts) do |session|
    write_concern = if opts[:write_concern]
      WriteConcern.get(opts[:write_concern])
    else
      write_concern_with_session(session)
    end
    nro_write_with_retry(session, write_concern) do |server|
      apply_collation!(delete_doc, server, opts)
      apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))

      Operation::Delete.new(
          :deletes => [ delete_doc ],
          :db_name => collection.database.name,
          :coll_name => collection.name,
          :write_concern => write_concern,
          :bypass_document_validation => !!opts[:bypass_document_validation],
          :session => session
      ).execute(server, client: client)
    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. @option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@option opts [ Hash ] :write_concern The write concern options.

Can be :w => Integer, :fsync => Boolean, :j => Boolean.

@return [ Result ] The response from the database.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 224
def delete_one(opts = {})
  QueryCache.clear_namespace(collection.namespace)

  delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
  with_session(opts) do |session|
    write_concern = if opts[:write_concern]
      WriteConcern.get(opts[:write_concern])
    else
      write_concern_with_session(session)
    end
    write_with_retry(session, write_concern) do |server, txn_num|
      apply_collation!(delete_doc, server, opts)
      apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))

      Operation::Delete.new(
          :deletes => [ delete_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, client: client)
    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 [ Integer ] :max_time_ms The maximum amount of time to allow the command

to run in milliseconds.

@option opts [ Hash ] :projection The fields to include or exclude in the returned doc. @option opts [ Hash ] :sort The key and direction pairs by which the result set

will be sorted.

@option opts [ Hash ] :collation The collation to use. @option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@return [ BSON::Document, nil ] The document, if found.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 50
def find_one_and_delete(opts = {})
  QueryCache.clear_namespace(collection.namespace)

  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
  if opts[:bypass_document_validation]
    cmd[:bypassDocumentValidation] = true
  end

  with_session(opts) do |session|
    applied_write_concern = applied_write_concern(session)
    cmd[:writeConcern] = applied_write_concern.options if applied_write_concern
    write_with_retry(session, applied_write_concern) do |server, txn_num|
      apply_collation!(cmd, server, opts)
      apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))

      Operation::Command.new(
          :selector => cmd,
          :db_name => database.name,
          :session => session,
          :txn_num => txn_num
      ).execute(server, client: client)
    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 ] :collation The collation to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@return [ BSON::Document ] The document.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 100
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 options [ Integer ] :max_time_ms The maximum amount of time to allow the command

to run in milliseconds.

@option opts [ Hash ] :projection The fields to include or exclude in the returned doc. @option opts [ Hash ] :sort The key and direction pairs by which the result set

will be sorted.

@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 ] :collation The collation to use. @option opts [ Array ] :array_filters A set of filters specifying to which array elements an update should apply. @option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@return [ BSON::Document ] The document.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 131
def find_one_and_update(document, opts = {})
  QueryCache.clear_namespace(collection.namespace)

  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
  if opts[:bypass_document_validation]
    cmd[:bypassDocumentValidation] = true
  end

  value = with_session(opts) do |session|
    applied_write_concern = applied_write_concern(opts[:session])
    cmd[:writeConcern] = applied_write_concern.options if applied_write_concern
    write_with_retry(session, applied_write_concern) do |server, txn_num|
      apply_collation!(cmd, server, opts)
      apply_array_filters!(cmd, server, opts)
      apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))

      Operation::Command.new(
          :selector => cmd,
          :db_name => database.name,
          :session => session,
          :txn_num => txn_num
      ).execute(server, client: client)
    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 [ true, false ] :bypass_document_validation Whether or

not to skip document level validation.

@option opts [ Hash ] :collation The collation to use. @option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@option opts [ Hash ] :write_concern The write concern options.

Can be :w => Integer, :fsync => Boolean, :j => Boolean.

@return [ Result ] The response from the database.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 273
def replace_one(replacement, opts = {})
  QueryCache.clear_namespace(collection.namespace)

  update_doc = { Operation::Q => filter,
                 Operation::U => replacement,
                }
  if opts[:upsert]
    update_doc['upsert'] = true
  end
  with_session(opts) do |session|
    write_concern = if opts[:write_concern]
      WriteConcern.get(opts[:write_concern])
    else
      write_concern_with_session(session)
    end

    write_with_retry(session, write_concern) do |server, txn_num|
      apply_collation!(update_doc, server, opts)
      apply_array_filters!(update_doc, server, opts)
      apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))

      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, client: client)
    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 | Array<Hash> ] spec The update document or pipeline. @param [ Hash ] opts The options.

@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 ] :collation The collation to use. @option opts [ Array ] :array_filters A set of filters specifying to

which array elements an update should apply.

@option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@option opts [ Hash ] :write_concern The write concern options.

Can be :w => Integer, :fsync => Boolean, :j => Boolean.

@return [ Result ] The response from the database.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 331
def update_many(spec, opts = {})
  QueryCache.clear_namespace(collection.namespace)

  update_doc = { Operation::Q => filter,
                 Operation::U => spec,
                 Operation::MULTI => true,
                 }
  if opts[:upsert]
    update_doc['upsert'] = true
  end
  with_session(opts) do |session|
    write_concern = if opts[:write_concern]
      WriteConcern.get(opts[:write_concern])
    else
      write_concern_with_session(session)
    end
    nro_write_with_retry(session, write_concern) do |server|
      apply_collation!(update_doc, server, opts)
      apply_array_filters!(update_doc, server, opts)
      apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))

      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
      ).execute(server, client: client)
    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 | Array<Hash> ] spec The update document or pipeline. @param [ Hash ] opts The options.

@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 ] :collation The collation to use. @option opts [ Array ] :array_filters A set of filters specifying to

which array elements an update should apply.

@option opts [ Session ] :session The session to use. @option opts [ Hash | String ] :hint The index to use for this operation.

May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").

@option opts [ Hash ] :write_concern The write concern options.

Can be :w => Integer, :fsync => Boolean, :j => Boolean.

@return [ Result ] The response from the database.

@since 2.0.0

# File lib/mongo/collection/view/writable.rb, line 388
def update_one(spec, opts = {})
  QueryCache.clear_namespace(collection.namespace)

  update_doc = { Operation::Q => filter,
                 Operation::U => spec,
                 }
  if opts[:upsert]
    update_doc['upsert'] = true
  end
  with_session(opts) do |session|
    write_concern = if opts[:write_concern]
      WriteConcern.get(opts[:write_concern])
    else
      write_concern_with_session(session)
    end
    write_with_retry(session, write_concern) do |server, txn_num|
      apply_collation!(update_doc, server, opts)
      apply_array_filters!(update_doc, server, opts)
      apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))

      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, client: client)
    end
  end
end

Private Instance Methods

applied_write_concern(session) click to toggle source

Get the write concern for an operation

@return [ Mongo::WriteConcern ] The write concern.

# File lib/mongo/collection/view/writable.rb, line 461
def applied_write_concern(session)
  if wco = options[:write_concern] || options[:write]
    WriteConcern.get(wco)
  else
    write_concern_with_session(session)
  end
end
apply_array_filters!(doc, server, opts = {}) click to toggle source
# File lib/mongo/collection/view/writable.rb, line 445
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
apply_hint!(doc, server, opts) click to toggle source
# File lib/mongo/collection/view/writable.rb, line 423
def apply_hint!(doc, server, opts)
  if hint = opts[:hint]
    features = server.with_connection do |connection|
      connection.description.features
    end

    write_concern = opts[:write_concern]
    if write_concern && !write_concern.acknowledged?
      raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
    end

    if doc.key?(:findAndModify) &&
        !features.find_and_modify_option_validation_enabled?
      raise Error::UnsupportedOption.hint_error
    elsif !features.update_delete_option_validation_enabled?
      raise Error::UnsupportedOption.hint_error
    end

    doc[:hint] = opts[:hint]
  end
end
validate_array_filters!(server, filters) click to toggle source
# File lib/mongo/collection/view/writable.rb, line 452
def validate_array_filters!(server, filters)
  if filters && !server.with_connection { |connection| connection.features }.array_filters_enabled?
    raise Error::UnsupportedArrayFilters.new
  end
end