Class: Mongo::DB
- Inherits:
-
Object
- Object
- Mongo::DB
- Includes:
- WriteConcern
- Defined in:
- lib/mongo/db.rb
Overview
A MongoDB database.
Constant Summary
- SYSTEM_NAMESPACE_COLLECTION =
'system.namespaces'- SYSTEM_INDEX_COLLECTION =
'system.indexes'- SYSTEM_PROFILE_COLLECTION =
'system.profile'- SYSTEM_USER_COLLECTION =
'system.users'- SYSTEM_JS_COLLECTION =
'system.js'- SYSTEM_COMMAND_COLLECTION =
'$cmd'- PROFILE_LEVEL =
{ :off => 0, :slow_only => 1, :all => 2 }
- @@current_request_id =
Counter for generating unique request ids.
0
Instance Attribute Summary (collapse)
-
- (Object) acceptable_latency
Read Preference.
-
- (Object) cache_time
The length of time that Collection.ensure_index should cache index calls.
-
- (Object) connection
readonly
The Mongo::MongoClient instance connecting to the MongoDB server.
-
- (Object) name
readonly
The name of the database and the local write concern options.
-
- (Object) read
Read Preference.
-
- (Object) tag_sets
Read Preference.
-
- (Object) write_concern
readonly
The name of the database and the local write concern options.
Attributes included from WriteConcern
Instance Method Summary (collapse)
-
- (String) add_stored_function(function_name, code)
Adds a stored Javascript function to the database which can executed server-side in map_reduce, db.eval and $where clauses.
-
- (Hash) add_user(username, password, read_only = false)
Adds a user to this database for use with authentication.
-
- (Boolean) authenticate(username, password, save_auth = true)
Authenticate with the given username and password.
-
- (Mongo::Collection) collection(name, opts = {})
(also: #[])
Get a collection by name.
-
- (Array) collection_names
Get an array of collection names in this database.
-
- (Array<Mongo::Collection>) collections
Get an array of Collection instances, one for each collection in this database.
-
- (Mongo::Cursor) collections_info(coll_name = nil)
Get info on system namespaces (collections).
-
- (Hash) command(selector, opts = {})
Send a command to the database.
-
- (Mongo::Collection) create_collection(name, opts = {})
Create a collection.
-
- (Hash) dereference(dbref)
Dereference a DBRef, returning the document it points to.
-
- (Boolean) drop_collection(name)
Drop a collection by
name. -
- (True) drop_index(collection_name, index_name)
Drop an index from a given collection.
-
- (Boolean) error?
Return
trueif an error was caused by the most recently executed database operation. -
- (String) eval(code, *args)
Evaluate a JavaScript expression in MongoDB.
-
- (String) full_collection_name(collection_name)
A shortcut returning db plus dot plus collection name.
-
- (Hash) get_last_error(opts = {})
Run the getlasterror command with the specified replication options.
-
- (Hash) index_information(collection_name)
Get information on the indexes for the given collection.
-
- (DB) initialize(name, client, opts = {})
constructor
Instances of DB are normally obtained by calling Mongo#db.
- - (Object) issue_authentication(username, password, save_auth = true, opts = {})
- - (Object) issue_logout(opts = {})
-
- (Boolean) logout(opts = {})
Deauthorizes use for this database for this client connection.
-
- (Boolean) ok?(doc)
Return
trueif the supplieddoccontains an 'ok' field with the value 1. -
- (Object, Nil) pk_factory
The primary key factory object (or
nil). -
- (Object) pk_factory=(pk_factory)
Specify a primary key factory if not already set.
-
- (String, Nil) previous_error
Get the most recent error to have occurred on this database.
-
- (Array) profiling_info
Get the current profiling information.
-
- (Symbol) profiling_level
Return the current database profiling level.
-
- (Object) profiling_level=(level)
Set this database's profiling level.
-
- (Boolean) remove_stored_function(function_name)
Removes stored Javascript function from the database.
-
- (Boolean) remove_user(username)
Remove the given user from this database.
-
- (True) rename_collection(from, to)
Rename a collection.
-
- (Hash) reset_error_history
Reset the error history of this database.
-
- (Hash) stats
Return stats on this database.
-
- (Object) strict=(value)
deprecated
Deprecated.
Support for strict will be removed in version 2.0 of the driver.
-
- (Boolean) strict?
deprecated
Deprecated.
Support for strict will be removed in version 2.0 of the driver.
-
- (Hash) validate_collection(name)
Validate a named collection.
Methods included from WriteConcern
#get_write_concern, gle?, #write_concern_from_legacy
Constructor Details
- (DB) initialize(name, client, opts = {})
Instances of DB are normally obtained by calling Mongo#db.
performed during a number of relevant operations. See DB#collection, DB#create_collection and DB#drop_collection.
Core docs:
90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/mongo/db.rb', line 90 def initialize(name, client, opts={}) @name = Mongo::Support.validate_db_name(name) @connection = client @strict = opts[:strict] @pk_factory = opts[:pk] @write_concern = get_write_concern(opts, client) @read = opts[:read] || @connection.read Mongo::ReadPreference::validate(@read) @tag_sets = opts.fetch(:tag_sets, @connection.tag_sets) @acceptable_latency = opts.fetch(:acceptable_latency, @connection.acceptable_latency) @cache_time = opts[:cache_time] || 300 #5 minutes. end |
Instance Attribute Details
- (Object) acceptable_latency
Read Preference
58 59 60 |
# File 'lib/mongo/db.rb', line 58 def acceptable_latency @acceptable_latency end |
- (Object) cache_time
The length of time that Collection.ensure_index should cache index calls
55 56 57 |
# File 'lib/mongo/db.rb', line 55 def cache_time @cache_time end |
- (Object) connection (readonly)
The Mongo::MongoClient instance connecting to the MongoDB server.
52 53 54 |
# File 'lib/mongo/db.rb', line 52 def connection @connection end |
- (Object) name (readonly)
The name of the database and the local write concern options.
49 50 51 |
# File 'lib/mongo/db.rb', line 49 def name @name end |
- (Object) tag_sets
Read Preference
58 59 60 |
# File 'lib/mongo/db.rb', line 58 def tag_sets @tag_sets end |
- (Object) write_concern (readonly)
The name of the database and the local write concern options.
49 50 51 |
# File 'lib/mongo/db.rb', line 49 def write_concern @write_concern end |
Instance Method Details
- (String) add_stored_function(function_name, code)
Adds a stored Javascript function to the database which can executed server-side in map_reduce, db.eval and $where clauses.
161 162 163 164 165 166 167 168 |
# File 'lib/mongo/db.rb', line 161 def add_stored_function(function_name, code) self[SYSTEM_JS_COLLECTION].save( { "_id" => function_name, :value => BSON::Code.new(code) } ) end |
- (Hash) add_user(username, password, read_only = false)
Adds a user to this database for use with authentication. If the user already exists in the system, the password will be updated.
190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/mongo/db.rb', line 190 def add_user(username, password, read_only = false) users = self[SYSTEM_USER_COLLECTION] user = users.find_one({:user => username}) || {:user => username} user['pwd'] = Mongo::Support.hash_password(username, password) user['readOnly'] = true if read_only; begin users.save(user) rescue OperationFailure => ex # adding first admin user fails GLE in MongoDB 2.2 raise ex unless ex. =~ /login/ end user end |
- (Boolean) authenticate(username, password, save_auth = true)
Authenticate with the given username and password. Note that mongod must be started with the –auth option for authentication to be enabled.
Core docs:
120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/mongo/db.rb', line 120 def authenticate(username, password, save_auth=true) if @connection.pool_size > 1 && !save_auth raise MongoArgumentError, "If using connection pooling, :save_auth must be set to true." end begin socket = @connection.checkout_reader(:mode => :primary_preferred) issue_authentication(username, password, save_auth, :socket => socket) ensure socket.checkin if socket end @connection.authenticate_pools end |
- (Mongo::Collection) collection(name, opts = {}) Also known as: []
Get a collection by name.
319 320 321 322 323 324 325 326 327 |
# File 'lib/mongo/db.rb', line 319 def collection(name, opts={}) if strict? && !collection_names.include?(name.to_s) raise MongoDBError, "Collection '#{name}' doesn't exist. (strict=true)" else opts = opts.dup opts.merge!(:pk => @pk_factory) unless opts[:pk] Collection.new(name, self, opts) end end |
- (Array) collection_names
Get an array of collection names in this database.
242 243 244 245 246 |
# File 'lib/mongo/db.rb', line 242 def collection_names names = collections_info.collect { |doc| doc['name'] || '' } names = names.delete_if {|name| name.index(@name).nil? || name.index('$')} names.map {|name| name.sub(@name + '.', '')} end |
- (Array<Mongo::Collection>) collections
Get an array of Collection instances, one for each collection in this database.
251 252 253 254 255 |
# File 'lib/mongo/db.rb', line 251 def collections collection_names.map do |name| Collection.new(name, self) end end |
- (Mongo::Cursor) collections_info(coll_name = nil)
Get info on system namespaces (collections). This method returns a cursor which can be iterated over. For each collection, a hash will be yielded containing a 'name' string and, optionally, an 'options' hash.
264 265 266 267 268 |
# File 'lib/mongo/db.rb', line 264 def collections_info(coll_name=nil) selector = {} selector[:name] = full_collection_name(coll_name) if coll_name Cursor.new(Collection.new(SYSTEM_NAMESPACE_COLLECTION, self), :selector => selector) end |
- (Hash) command(selector, opts = {})
Send a command to the database.
Note: DB commands must start with the “command” key. For this reason, any selector containing more than one key must be an OrderedHash.
Note also that a command in MongoDB is just a kind of query that occurs on the system command collection ($cmd). Examine this method's implementation to see how it works.
key, specifying the command to be performed. In Ruby 1.9, OrderedHash isn't necessary since hashes are ordered by default.
Core docs:
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
# File 'lib/mongo/db.rb', line 510 def command(selector, opts={}) check_response = opts.fetch(:check_response, true) socket = opts[:socket] raise MongoArgumentError, "Command must be given a selector" unless selector.is_a?(Hash) && !selector.empty? if selector.keys.length > 1 && RUBY_VERSION < '1.9' && selector.class != BSON::OrderedHash raise MongoArgumentError, "DB#command requires an OrderedHash when hash contains multiple keys" end if read_pref = opts[:read] Mongo::ReadPreference::validate(read_pref) unless read_pref == :primary || Mongo::Support::secondary_ok?(selector) raise MongoArgumentError, "Command is not supported on secondaries: #{selector.keys.first}" end end begin result = Cursor.new( system_command_collection, :limit => -1, :selector => selector, :socket => socket, :read => read_pref, :comment => opts[:comment]).next_document rescue OperationFailure => ex raise OperationFailure, "Database command '#{selector.keys.first}' failed: #{ex.}" end raise OperationFailure, "Database command '#{selector.keys.first}' failed: returned null." unless result if check_response && !ok?(result) = "Database command '#{selector.keys.first}' failed: (" << result.map do |key, value| "#{key}: '#{value}'" end.join('; ') << ').' code = result['code'] || result['assertionCode'] raise OperationFailure.new(, code, result) end result end |
- (Mongo::Collection) create_collection(name, opts = {})
Create a collection.
new collection. If strict is true, will raise an error if
collection name already exists.
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/mongo/db.rb', line 292 def create_collection(name, opts={}) name = name.to_s if strict? && collection_names.include?(name) raise MongoDBError, "Collection '#{name}' already exists. (strict=true)" end begin cmd = BSON::OrderedHash.new cmd[:create] = name doc = command(cmd.merge(opts || {})) return Collection.new(name, self, :pk => @pk_factory) if ok?(doc) rescue OperationFailure => e return Collection.new(name, self, :pk => @pk_factory) if e. =~ /exists/ raise e end raise MongoDBError, "Error creating collection: #{doc.inspect}" end |
- (Hash) dereference(dbref)
Dereference a DBRef, returning the document it points to.
399 400 401 |
# File 'lib/mongo/db.rb', line 399 def dereference(dbref) collection(dbref.namespace).find_one("_id" => dbref.object_id) end |
- (Boolean) drop_collection(name)
Drop a collection by name.
335 336 337 338 339 340 341 342 |
# File 'lib/mongo/db.rb', line 335 def drop_collection(name) return false if strict? && !collection_names.include?(name.to_s) begin ok?(command(:drop => name)) rescue OperationFailure => e false end end |
- (True) drop_index(collection_name, index_name)
Drop an index from a given collection. Normally called from Collection#drop_index or Collection#drop_indexes.
447 448 449 450 451 452 453 |
# File 'lib/mongo/db.rb', line 447 def drop_index(collection_name, index_name) cmd = BSON::OrderedHash.new cmd[:deleteIndexes] = collection_name cmd[:index] = index_name.to_s doc = command(cmd, :check_response => false) ok?(doc) || raise(MongoDBError, "Error with drop_index command: #{doc.inspect}") end |
- (Boolean) error?
Return true if an error was caused by the most recently
executed database operation.
367 368 369 |
# File 'lib/mongo/db.rb', line 367 def error? get_last_error['err'] != nil end |
- (String) eval(code, *args)
Evaluate a JavaScript expression in MongoDB.
410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/mongo/db.rb', line 410 def eval(code, *args) unless code.is_a?(BSON::Code) code = BSON::Code.new(code) end cmd = BSON::OrderedHash.new cmd[:$eval] = code cmd[:args] = args doc = command(cmd) doc['retval'] end |
- (String) full_collection_name(collection_name)
A shortcut returning db plus dot plus collection name.
559 560 561 |
# File 'lib/mongo/db.rb', line 559 def full_collection_name(collection_name) "#{@name}.#{collection_name}" end |
- (Hash) get_last_error(opts = {})
Run the getlasterror command with the specified replication options.
354 355 356 357 358 359 360 361 |
# File 'lib/mongo/db.rb', line 354 def get_last_error(opts={}) cmd = BSON::OrderedHash.new cmd[:getlasterror] = 1 cmd.merge!(opts) doc = command(cmd, :check_response => false) raise MongoDBError, "Error retrieving last error: #{doc.inspect}" unless ok?(doc) doc end |
- (Hash) index_information(collection_name)
Get information on the indexes for the given collection. Normally called by Collection#index_information.
462 463 464 465 466 467 468 469 |
# File 'lib/mongo/db.rb', line 462 def index_information(collection_name) sel = {:ns => full_collection_name(collection_name)} info = {} Cursor.new(Collection.new(SYSTEM_INDEX_COLLECTION, self), :selector => sel).each do |index| info[index['name']] = index end info end |
- (Object) issue_authentication(username, password, save_auth = true, opts = {})
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/mongo/db.rb', line 135 def issue_authentication(username, password, save_auth=true, opts={}) doc = command({:getnonce => 1}, :check_response => false, :socket => opts[:socket]) raise MongoDBError, "Error retrieving nonce: #{doc}" unless ok?(doc) nonce = doc['nonce'] auth = BSON::OrderedHash.new auth['authenticate'] = 1 auth['user'] = username auth['nonce'] = nonce auth['key'] = Mongo::Support.auth_key(username, password, nonce) if ok?(doc = self.command(auth, :check_response => false, :socket => opts[:socket])) @connection.add_auth(@name, username, password) if save_auth else = "Failed to authenticate user '#{username}' on db '#{self.name}'" raise Mongo::AuthenticationError.new(, doc['code'], doc) end true end |
- (Object) issue_logout(opts = {})
230 231 232 233 234 235 236 237 |
# File 'lib/mongo/db.rb', line 230 def issue_logout(opts={}) if ok?(doc = command({:logout => 1}, :socket => opts[:socket])) @connection.remove_auth(@name) else raise MongoDBError, "Error logging out: #{doc.inspect}" end true end |
- (Boolean) logout(opts = {})
Deauthorizes use for this database for this client connection. Also removes any saved authentication in the MongoClient class associated with this database.
225 226 227 228 |
# File 'lib/mongo/db.rb', line 225 def logout(opts={}) @connection.logout_pools(@name) if @connection.pool_size > 1 issue_logout(opts) end |
- (Boolean) ok?(doc)
Return true if the supplied doc contains an
'ok' field with the value 1.
483 484 485 |
# File 'lib/mongo/db.rb', line 483 def ok?(doc) Mongo::Support.ok?(doc) end |
- (Object, Nil) pk_factory
The primary key factory object (or nil).
566 567 568 |
# File 'lib/mongo/db.rb', line 566 def pk_factory @pk_factory end |
- (Object) pk_factory=(pk_factory)
Specify a primary key factory if not already set.
573 574 575 576 577 578 |
# File 'lib/mongo/db.rb', line 573 def pk_factory=(pk_factory) raise MongoArgumentError, "Cannot change primary key factory once it's been set" if @pk_factory @pk_factory = pk_factory end |
- (String, Nil) previous_error
Get the most recent error to have occurred on this database.
This command only returns errors that have occurred since the last call to
DB#reset_error_history - returns nil if there is no such
error.
377 378 379 380 |
# File 'lib/mongo/db.rb', line 377 def previous_error error = command(:getpreverror => 1) error["err"] ? error : nil end |
- (Array) profiling_info
Get the current profiling information.
612 613 614 |
# File 'lib/mongo/db.rb', line 612 def profiling_info Cursor.new(Collection.new(SYSTEM_PROFILE_COLLECTION, self), :selector => {}).to_a end |
- (Symbol) profiling_level
Return the current database profiling level. If profiling is enabled, you can get the results using DB#profiling_info.
Core docs:
586 587 588 589 590 591 592 593 594 595 596 |
# File 'lib/mongo/db.rb', line 586 def profiling_level cmd = BSON::OrderedHash.new cmd[:profile] = -1 doc = command(cmd, :check_response => false) raise "Error with profile command: #{doc.inspect}" unless ok?(doc) level_sym = PROFILE_LEVEL.invert[doc['was'].to_i] raise "Error: illegal profiling level value #{doc['was']}" unless level_sym level_sym end |
- (Object) profiling_level=(level)
Set this database's profiling level. If profiling is enabled, you can get the results using DB#profiling_info.
602 603 604 605 606 607 |
# File 'lib/mongo/db.rb', line 602 def profiling_level=(level) cmd = BSON::OrderedHash.new cmd[:profile] = PROFILE_LEVEL[level] doc = command(cmd, :check_response => false) ok?(doc) || raise(MongoDBError, "Error with profile command: #{doc.inspect}") end |
- (Boolean) remove_stored_function(function_name)
Removes stored Javascript function from the database. Returns false if the function does not exist
176 177 178 179 |
# File 'lib/mongo/db.rb', line 176 def remove_stored_function(function_name) return false unless self[SYSTEM_JS_COLLECTION].find_one({"_id" => function_name}) self[SYSTEM_JS_COLLECTION].remove({"_id" => function_name}, :w => 1) end |
- (Boolean) remove_user(username)
Remove the given user from this database. Returns false if the user doesn't exist in the system.
210 211 212 213 214 215 216 |
# File 'lib/mongo/db.rb', line 210 def remove_user(username) if self[SYSTEM_USER_COLLECTION].find_one({:user => username}) self[SYSTEM_USER_COLLECTION].remove({:user => username}, :w => 1) else false end end |
- (True) rename_collection(from, to)
Rename a collection.
430 431 432 433 434 435 436 |
# File 'lib/mongo/db.rb', line 430 def rename_collection(from, to) cmd = BSON::OrderedHash.new cmd[:renameCollection] = "#{@name}.#{from}" cmd[:to] = "#{@name}.#{to}" doc = DB.new('admin', @connection).command(cmd, :check_response => false) ok?(doc) || raise(MongoDBError, "Error renaming collection: #{doc.inspect}") end |
- (Hash) reset_error_history
Reset the error history of this database
Calls to DB#previous_error will only return errors that have occurred since the most recent call to this method.
388 389 390 |
# File 'lib/mongo/db.rb', line 388 def reset_error_history command(:reseterror => 1) end |
- (Hash) stats
Return stats on this database. Uses MongoDB's dbstats command.
474 475 476 |
# File 'lib/mongo/db.rb', line 474 def stats self.command({:dbstats => 1}) end |
- (Object) strict=(value)
Support for strict will be removed in version 2.0 of the driver.
Strict mode enforces collection existence checks. When true,
asking for a collection that does not exist, or trying to create a
collection that already exists, raises an error.
Strict mode is disabled by default, but enabled (true) at any
time.
33 34 35 36 37 38 39 |
# File 'lib/mongo/db.rb', line 33 def strict=(value) unless ENV['TEST_MODE'] warn "Support for strict mode has been deprecated and will be " + "removed in version 2.0 of the driver." end @strict = value end |
- (Boolean) strict?
Support for strict will be removed in version 2.0 of the driver.
Returns the value of the strict flag.
44 45 46 |
# File 'lib/mongo/db.rb', line 44 def strict? @strict end |
- (Hash) validate_collection(name)
Validate a named collection.
624 625 626 627 628 629 630 631 632 633 634 635 636 |
# File 'lib/mongo/db.rb', line 624 def validate_collection(name) cmd = BSON::OrderedHash.new cmd[:validate] = name cmd[:full] = true doc = command(cmd, :check_response => false) raise MongoDBError, "Error with validate command: #{doc.inspect}" unless ok?(doc) if (doc.has_key?('valid') && !doc['valid']) || (doc['result'] =~ /\b(exception|corrupt)\b/i) raise MongoDBError, "Error: invalid collection #{name}: #{doc.inspect}" end doc end |