Parent

Files

Class/Module Index [+]

Quicksearch

Moneta::Adapters::Mongo

MongoDB backend

Supports expiration, documents will be automatically removed starting with mongodb >= 2.2 (see {docs.mongodb.org/manual/tutorial/expire-data/}).

You can store hashes directly using this adapter.

@example Store hashes

db = Moneta::Adapters::Mongo.new
db['key'] = {a: 1, b: 2}

@api public

Attributes

backend[R]

Public Class Methods

new(options = {}) click to toggle source

@param [Hash] options @option options [String] :collection ('moneta') MongoDB collection name @option options [String] :host ('127.0.0.1') MongoDB server host @option options [String] :user Username used to authenticate @option options [String] :password Password used to authenticate @option options [Integer] :port (MongoDB default port) MongoDB server port @option options [String] :db ('moneta') MongoDB database @option options [Integer] :expires Default expiration time @option options [String] :expires_field ('expiresAt') Document field to store expiration time @option options [String] :value_field ('value') Document field to store value @option options [String] :type_field ('type') Document field to store value type @option options [::Mongo::MongoClient] :backend Use existing backend instance @option options Other options passed to `Mongo::MongoClient#new`

# File lib/moneta/adapters/mongo.rb, line 37
def initialize(options = {})
  self.default_expires = options.delete(:expires)
  collection = options.delete(:collection) || 'moneta'
  db = options.delete(:db) || 'moneta'
  @expires_field = options.delete(:expires_field) || 'expiresAt'
  @value_field = options.delete(:value_field) || 'value'
  @type_field = options.delete(:type_field) || 'type'
  @backend = options[:backend] ||
    begin
      host = options.delete(:host) || '127.0.0.1'
      port = options.delete(:port) || ::Mongo::MongoClient::DEFAULT_PORT
      user = options.delete(:user)
      password = options.delete(:password)
      ::Mongo::MongoClient.new(host, port, options)
    end
  db = @backend.db(db)
  db.authenticate(user, password, true) if user && password
  @collection = db.collection(collection)
  if @backend.server_version >= '2.2'
    @collection.ensure_index([[@expires_field, ::Mongo::ASCENDING]], :expireAfterSeconds => 0)
  else
    warn 'Moneta::Adapters::Mongo - You are using MongoDB version < 2.2, expired documents will not be deleted'
  end
end

Public Instance Methods

clear(options = {}) click to toggle source

(see Proxy#clear)

# File lib/moneta/adapters/mongo.rb, line 111
def clear(options = {})
  @collection.remove
  self
end
close() click to toggle source

(see Proxy#close)

# File lib/moneta/adapters/mongo.rb, line 117
def close
  @backend.close
  nil
end
create(key, value, options = {}) click to toggle source

(see Proxy#create)

# File lib/moneta/adapters/mongo.rb, line 100
def create(key, value, options = {})
  key = to_binary(key)
  @collection.insert(value_to_doc(key, value, options))
  true
rescue ::Mongo::OperationFailure
  # FIXME: This catches too many errors
  # it should only catch a not-unique-exception
  false
end
delete(key, options = {}) click to toggle source

(see Proxy#delete)

# File lib/moneta/adapters/mongo.rb, line 85
def delete(key, options = {})
  value = load(key, options)
  @collection.remove('_id' => to_binary(key)) if value
  value
end
increment(key, amount = 1, options = {}) click to toggle source

(see Proxy#increment)

# File lib/moneta/adapters/mongo.rb, line 92
def increment(key, amount = 1, options = {})
  @collection.find_and_modify(:query => { '_id' => to_binary(key) },
                              :update => { '$inc' => { @value_field => amount } },
                              :new => true,
                              :upsert => true)[@value_field]
end
load(key, options = {}) click to toggle source

(see Proxy#load)

# File lib/moneta/adapters/mongo.rb, line 63
def load(key, options = {})
  key = to_binary(key)
  doc = @collection.find_one('_id' => key)
  if doc && (!doc[@expires_field] || doc[@expires_field] >= Time.now)
    expires = expires_at(options, nil)
    @collection.update({ '_id' => key },
                       # @expires_field must be a Time object (BSON date datatype)
                       { '$set' => { @expires_field => expires || nil } }) if expires != nil
    doc_to_value(doc)
  end
end
store(key, value, options = {}) click to toggle source

(see Proxy#store)

# File lib/moneta/adapters/mongo.rb, line 76
def store(key, value, options = {})
  key = to_binary(key)
  @collection.update({ '_id' => key },
                     value_to_doc(key, value, options),
                     { :upsert => true })
  value
end

Protected Instance Methods

doc_to_value(doc) click to toggle source
# File lib/moneta/adapters/mongo.rb, line 124
def doc_to_value(doc)
  case doc[@type_field]
  when 'Hash'
    doc = doc.dup
    doc.delete('_id')
    doc.delete(@type_field)
    doc.delete(@expires_field)
    doc
  when 'Number'
    doc[@value_field]
  else
    doc[@value_field].to_s
  end
end
to_binary(s) click to toggle source
# File lib/moneta/adapters/mongo.rb, line 164
def to_binary(s)
  s = s.dup if s.frozen? # HACK: BSON::Binary needs unfrozen string
  ::BSON::Binary.new(s)
end
value_to_doc(key, value, options) click to toggle source
# File lib/moneta/adapters/mongo.rb, line 139
def value_to_doc(key, value, options)
  case value
  when Hash
    value.merge('_id' => key,
                @type_field => 'Hash',
                # @expires_field must be a Time object (BSON date datatype)
                @expires_field => expires_at(options) || nil)
  when Float, Fixnum
    { '_id' => key,
      @type_field => 'Number',
      @value_field => value,
      # @expires_field must be a Time object (BSON date datatype)
      @expires_field => expires_at(options) || nil }
  when String
    intvalue = value.to_i
    { '_id' => key,
      @type_field => 'String',
      @value_field => intvalue.to_s == value ? intvalue : to_binary(value),
      # @expires_field must be a Time object (BSON date datatype)
      @expires_field => expires_at(options) || nil }
  else
    raise ArgumentError, "Invalid value type: #{value.class}"
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.