Class: BSON::ObjectId

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

Overview

Generates MongoDB object ids.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = nil, time = nil) ⇒ ObjectId

Create a new object id. If no parameter is given, an id corresponding to the ObjectId BSON data type will be created. This is a 12-byte value consisting of a 4-byte timestamp, a 3-byte machine id, a 2-byte process id, and a 3-byte counter.

Parameters:

  • data (Array) (defaults to: nil) —

    should be an array of bytes. If you want to generate a standard MongoDB object id, leave this argument blank.

  • opts (Hash) —

    a customizable set of options



47
48
49
 
# File 'lib/bson/types/object_id.rb', line 47

def initialize(data=nil, time=nil)
  @data = data || generate(time)
end

Instance Attribute Details

#data ⇒ Object

Returns the value of attribute data.



33
34
35
 
# File 'lib/bson/types/object_id.rb', line 33

def data
  @data
end

Class Method Details

.create_pk(doc) ⇒ BSON::ObjectId, Object

Adds a primary key to the given document if needed.

Parameters:

  • doc (Hash) —

    a document requiring an _id.

Returns:

  • (BSON::ObjectId, Object) —

    returns a newly-created or current _id for the given document.



92
93
94
 
# File 'lib/bson/types/object_id.rb', line 92

def self.create_pk(doc)
  doc.has_key?(:_id) || doc.has_key?('_id') ? doc : doc.merge!(:_id => self.new)
end

.from_string(str) ⇒ BSON::ObjectId

Given a string representation of an ObjectId, return a new ObjectId with that value.

Parameters:

  • str (String)

Returns:

Raises:



125
126
127
128
129
130
131
132
 
# File 'lib/bson/types/object_id.rb', line 125

def self.from_string(str)
  raise InvalidObjectId, "illegal ObjectId format: #{str}" unless legal?(str)
  data = []
  12.times do |i|
    data[i] = str[i * 2, 2].to_i(16)
  end
  self.new(data)
end

.from_time(time, opts = {}) ⇒ BSON::ObjectId

Create an object id from the given time. This is useful for doing range queries; it works because MongoDB’s object ids begin with a timestamp.

Examples:

Return all document created before Jan 1, 2010.

time = Time.utc(2010, 1, 1)
time_id = ObjectId.from_time(time)
collection.find({'_id' => {'$lt' => time_id}})

Parameters:

  • time (Time) —

    a utc time to encode as an object id.

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

    a customizable set of options

Options Hash (opts):

  • (false) (:unique) —

    If false, the object id’s bytes succeeding the timestamp will be zeroed; if true, they’ll consist of the standard machine id, pid, and counter.

Returns:



77
78
79
80
81
82
83
84
 
# File 'lib/bson/types/object_id.rb', line 77

def self.from_time(time, opts={})
  unique = opts.fetch(:unique, false)
  if unique
    self.new(nil, time)
  else
    self.new([time.to_i,0,0].pack("NNN").unpack("C12"))
  end
end

.legal?(str) ⇒ Boolean

Determine if the supplied string is legal. Legal strings will consist of 24 hexadecimal characters.

Parameters:

  • str (String)

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/bson/types/object_id.rb', line 57

def self.legal?(str)
  str =~ /^[0-9a-f]{24}$/i ? true : false
end

.machine_id ⇒ Object 



170
171
172
 
# File 'lib/bson/types/object_id.rb', line 170

def self.machine_id
  @@machine_id
end

Instance Method Details

#as_json(options = {}) ⇒ Hash

Create the JSON hash structure convert to MongoDB extended format. Rails 2.3.3 introduced as_json to create the needed hash structure to encode objects into JSON.

Returns:

  • (Hash) —

    the hash representation as MongoDB extended JSON



157
158
159
 
# File 'lib/bson/types/object_id.rb', line 157

def as_json(options ={})
  {"$oid" => to_s}
end

#eql?(object_id) ⇒ Boolean Also known as: ==

Check equality of this object id with another.

Parameters:

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/bson/types/object_id.rb', line 99

def eql?(object_id)
  object_id.kind_of?(BSON::ObjectId) and self.data == object_id.data
end

#generation_time ⇒ Time

Return the UTC time at which this ObjectId was generated. This may be used in lieu of a created_at timestamp since this information is always encoded in the object id.

Returns:

  • (Time) —

    the time at which this object was created.



166
167
168
 
# File 'lib/bson/types/object_id.rb', line 166

def generation_time
  Time.at(@data.pack("C4").unpack("N")[0]).utc
end

#hash ⇒ Integer

Get a unique hashcode for this object. This is required since we’ve defined an #eql? method.

Returns:

  • (Integer) 


108
109
110
 
# File 'lib/bson/types/object_id.rb', line 108

def hash
  @data.hash
end

#inspect ⇒ Object 



141
142
143
 
# File 'lib/bson/types/object_id.rb', line 141

def inspect
  "BSON::ObjectId('#{to_s}')"
end

#to_a ⇒ Array

Get an array representation of the object id.

Returns:

  • (Array) 


115
116
117
 
# File 'lib/bson/types/object_id.rb', line 115

def to_a
  @data.dup
end

#to_json(*a) ⇒ String

Convert to MongoDB extended JSON format. Since JSON includes type information, but lacks an ObjectId type, this JSON format encodes the type using an $oid key.

Returns:

  • (String) —

    the object id represented as MongoDB extended JSON.



149
150
151
 
# File 'lib/bson/types/object_id.rb', line 149

def to_json(*a)
  "{\"$oid\": \"#{to_s}\"}"
end

#to_s ⇒ String

Get a string representation of this object id.

Returns:

  • (String) 


137
138
139
 
# File 'lib/bson/types/object_id.rb', line 137

def to_s
  @data.map {|e| v=e.to_s(16); v.size == 1 ? "0#{v}" : v }.join
end