Class: Mongo::WriteConcern::Acknowledged

Inherits:
Base
  • Object
show all
Defined in:
lib/mongo/write_concern/acknowledged.rb

Overview

An acknowledged write concern provides a get last error command with the appropriate options on each write operation.

Since:

  • 2.0.0

Instance Attribute Summary

Attributes inherited from Base

#options

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from Mongo::WriteConcern::Base

Instance Method Details

#acknowledged? ⇒ true, false

Is this write concern acknowledged.

Examples:

Whether this write concern object is acknowledged.

write_concern.acknowledged?

Returns:

  • (true, false) —

    Whether this write concern is acknowledged.

Since:

  • 2.5.0



48
49
50
 
# File 'lib/mongo/write_concern/acknowledged.rb', line 48

def acknowledged?
  true
end

#get_last_error ⇒ Hash

Get the get last error command for the concern.

Examples:

Get the gle command.

acknowledged.get_last_error

Returns:

  • (Hash) —

    The gle command.

Since:

  • 2.0.0



34
35
36
37
38
 
# File 'lib/mongo/write_concern/acknowledged.rb', line 34

def get_last_error
  @get_last_error ||= { GET_LAST_ERROR => 1 }.merge(
    Options::Mapper.transform_values_to_strings(options)
  )
end

#inspect ⇒ String

Get a human-readable string representation of an acknowledged write concern.

Examples:

Inspect the write concern.

write_concern.inspect

Returns:

  • (String) —

    A string representation of an acknowledged write concern.

Since:

  • 2.0.0



60
61
62
 
# File 'lib/mongo/write_concern/acknowledged.rb', line 60

def inspect
  "#<Mongo::WriteConcern::Acknowledged:0x#{object_id} options=#{options}>"
end