Class: Moneta::Adapters::MongoOfficial
- Defined in:
- lib/moneta/adapters/mongo/official.rb
Overview
MongoDB backend
Supports expiration, documents will be automatically removed starting with mongodb >= 2.2 (see /).
You can store hashes directly using this adapter.
Constant Summary
Constants inherited from MongoBase
Moneta::Adapters::MongoBase::DEFAULT_PORT
Instance Attribute Summary
Attributes inherited from MongoBase
Attributes included from ExpiresSupport
Instance Method Summary collapse
-
#clear(options = {}) ⇒ void
Clear all keys in this store.
-
#close ⇒ Object
Explicitly close the store.
-
#create(key, value, options = {}) ⇒ Boolean
Atomically sets a key to value if it’s not set.
-
#delete(key, options = {}) ⇒ Object
Delete the key from the store and return the current value.
-
#increment(key, amount = 1, options = {}) ⇒ Object
Atomically increment integer value with key.
-
#initialize(options = {}) ⇒ MongoOfficial
constructor
A new instance of MongoOfficial.
-
#load(key, options = {}) ⇒ Object
Fetch value with key.
-
#store(key, value, options = {}) ⇒ Object
Store value with key.
Methods included from Defaults
#[], #[]=, #decrement, #features, #fetch, included, #key?, #supports?
Methods included from OptionSupport
#expires, #prefix, #raw, #with
Constructor Details
#initialize(options = {}) ⇒ MongoOfficial
Returns a new instance of MongoOfficial.
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/moneta/adapters/mongo/official.rb', line 32 def initialize( = {}) super() collection = .delete(:collection) || 'moneta' db = .delete(:db) || 'moneta' @backend = [:backend] || begin host = .delete(:host) || '127.0.0.1' port = .delete(:port) || DEFAULT_PORT [:logger] ||= ::Logger.new(STDERR).tap do |logger| logger.level = ::Logger::ERROR end ::Mongo::Client.new(["#{host}:#{port}"], ) end @backend.use(db) @collection = @backend[collection] if @backend.command(buildinfo: 1).documents.first['version'] >= '2.2' @collection.indexes.create_one({@expires_field => 1}, expire_after: 0) else warn 'Moneta::Adapters::Mongo - You are using MongoDB version < 2.2, expired documents will not be deleted' end end |
Instance Method Details
#clear(options = {}) ⇒ void
This method returns an undefined value.
Clear all keys in this store
105 106 107 108 |
# File 'lib/moneta/adapters/mongo/official.rb', line 105 def clear( = {}) @collection.delete_many self end |
#close ⇒ Object
Explicitly close the store
111 112 113 114 |
# File 'lib/moneta/adapters/mongo/official.rb', line 111 def close @backend.close nil end |
#create(key, value, options = {}) ⇒ Boolean
Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.
Atomically sets a key to value if it’s not set.
95 96 97 98 99 100 101 102 |
# File 'lib/moneta/adapters/mongo/official.rb', line 95 def create(key, value, = {}) key = to_binary(key) @collection.insert_one(value_to_doc(key, value, )) true rescue ::Mongo::Error::OperationFailure => ex raise unless ex. =~ /^E11000 / # duplicate key error false end |
#delete(key, options = {}) ⇒ Object
Delete the key from the store and return the current value
77 78 79 80 81 82 83 84 |
# File 'lib/moneta/adapters/mongo/official.rb', line 77 def delete(key, = {}) key = to_binary(key) if doc = @collection.find(_id: key).find_one_and_delete and !doc[@expires_field] || doc[@expires_field] >= Time.now then doc_to_value(doc) end end |
#increment(key, amount = 1, options = {}) ⇒ Object
Not every Moneta store implements this method, a NotImplementedError is raised if it is not supported.
Atomically increment integer value with key
This method also accepts negative amounts.
87 88 89 90 91 92 |
# File 'lib/moneta/adapters/mongo/official.rb', line 87 def increment(key, amount = 1, = {}) @collection.find_one_and_update({ _id: to_binary(key) }, { '$inc' => { @value_field => amount } }, :return_document => :after, :upsert => true)[@value_field] end |
#load(key, options = {}) ⇒ Object
Fetch value with key. Return nil if the key doesn’t exist
55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/moneta/adapters/mongo/official.rb', line 55 def load(key, = {}) key = to_binary(key) doc = @collection.find(_id: key).limit(1).first if doc && (!doc[@expires_field] || doc[@expires_field] >= Time.now) expires = expires_at(, nil) # @expires_field must be a Time object (BSON date datatype) @collection.update_one({ _id: key }, '$set' => { @expires_field => expires }) unless expires.nil? doc_to_value(doc) end end |
#store(key, value, options = {}) ⇒ Object
Store value with key
68 69 70 71 72 73 74 |
# File 'lib/moneta/adapters/mongo/official.rb', line 68 def store(key, value, = {}) key = to_binary(key) @collection.replace_one({ _id: key }, value_to_doc(key, value, ), upsert: true) value end |