Class: BSON::DBRef

Inherits:
Object
  • Object
show all
Defined in:
lib/bson/types/dbref.rb

Overview

A reference to another object in a MongoDB database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace, object_id) ⇒ DBRef

Create a DBRef. Use this class in conjunction with DB#dereference.

Parameters:

  • namespace (String) —

    a collection name.

  • object_id (ObjectId) —

    an object id.



26
27
28
29
 
# File 'lib/bson/types/dbref.rb', line 26

def initialize(namespace, object_id)
  @namespace = namespace
  @object_id = object_id
end

Instance Attribute Details

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



20
21
22
 
# File 'lib/bson/types/dbref.rb', line 20

def namespace
  @namespace
end

#object_id ⇒ Object (readonly)

Returns the value of attribute object_id.



20
21
22
 
# File 'lib/bson/types/dbref.rb', line 20

def object_id
  @object_id
end

Instance Method Details

#to_hash ⇒ Object 



35
36
37
 
# File 'lib/bson/types/dbref.rb', line 35

def to_hash
  {"$ns" => @namespace, "$id" => @object_id }
end

#to_s ⇒ Object 



31
32
33
 
# File 'lib/bson/types/dbref.rb', line 31

def to_s
  "ns: #{namespace}, id: #{object_id}"
end