Method: Mongo::Collection#find_one_and_replace

Defined in:

lib/mongo/collection.rb

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

Finds a single document and replaces it, returning the original doc unless otherwise specified.

Examples:

Find a document and replace it, returning the original.

collection.find_one_and_replace({ name: 'test' }, { name: 'test1' })

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

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

Parameters:

• filter (Hash) —

  The filter to use.

• replacement (BSON::Document) —

  The replacement document.

• options (Hash) (defaults to: {}) —

  The options.

Options Hash (options):

• :max_time_ms (Integer) —

  The maximum amount of time to allow the command to run in milliseconds.

• :projection (Hash) —

  The fields to include or exclude in the returned doc.

• :sort (Hash) —

  The key and direction pairs by which the result set will be sorted.

• :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.

• :session (Session) —

  The session to use.

• :hint (Hash | String) —

  The index to use for this operation. May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. “id”).

• :timeout_ms (Integer) —

  The operation timeout in milliseconds. Must be a non-negative integer. An explicit value of 0 means infinite. The default value is unset which means the value is inherited from the collection or the database or the client.

• :let (Hash) —

  Mapping of variables to use in the command. See the server documentation for details.

Returns:

• (BSON::Document) —

  The document.

Since:

• 2.1.0

# File 'lib/mongo/collection.rb', line 1263

def find_one_and_replace(filter, replacement, options = {})
  find(filter, options).find_one_and_update(replacement, options)
end