Class: Mongoid::Atomic::Paths::Root

Inherits:
Object
  • Object
show all
Defined in:
lib/mongoid/atomic/paths/root.rb

Overview

This class encapsulates behaviour for locating and updating root documents atomically.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document) ⇒ Root

Create the new root path utility.

Examples:

Create the root path util.

Root.new(document)

Parameters:

  • document (Document) —

    The document to generate the paths for.

Since:

  • 2.1.0



20
21
22
 
# File 'lib/mongoid/atomic/paths/root.rb', line 20

def initialize(document)
  @document, @path, @position = document, "", ""
end

Instance Attribute Details

#document ⇒ Object (readonly)

Returns the value of attribute document.



10
11
12
 
# File 'lib/mongoid/atomic/paths/root.rb', line 10

def document
  @document
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



10
11
12
 
# File 'lib/mongoid/atomic/paths/root.rb', line 10

def path
  @path
end

#position ⇒ Object (readonly)

Returns the value of attribute position.



10
11
12
 
# File 'lib/mongoid/atomic/paths/root.rb', line 10

def position
  @position
end

Instance Method Details

#selector ⇒ Hash

Get the selector to use for the root document when performing atomic updates. When sharding this will include the shard key.

Examples:

Get the selector.

root.selector

Returns:

  • (Hash) —

    The selector to identify the document with.

Since:

  • 2.1.0



33
34
35
36
 
# File 'lib/mongoid/atomic/paths/root.rb', line 33

def selector
  { "_id" => document.identifier || document._id }.
    merge!(document.shard_key_selector)
end