Class: Mongo::Connection

Inherits:
Object show all
Defined in:
lib/mongo/connection.rb

Overview

Instantiates and manages connections to MongoDB.

Direct Known Subclasses

ReplSetConnection

Constant Summary collapse

TCPSocket = 
::TCPSocket
UNIXSocket = 
::UNIXSocket
Mutex = 
::Mutex
ConditionVariable = 
::ConditionVariable
DEFAULT_PORT = 
27017
STANDARD_HEADER_SIZE = 
16
RESPONSE_HEADER_SIZE = 
20
@@current_request_id =

Counter for generating unique request ids.

0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host = nil, port = nil, opts = {}) ⇒ Connection

Create a connection to single MongoDB instance.

You may specify whether connection to slave is permitted. In all cases, the default host is “localhost” and the default port is 27017.

If you’re connecting to a replica set, you’ll need to use ReplSetConnection.new instead.

Once connected to a replica set, you can find out which nodes are primary, secondary, and arbiters with the corresponding accessors: Connection#primary, Connection#secondaries, and Connection#arbiters. This is useful if your application needs to connect manually to nodes other than the primary.

Examples:

localhost, 27017

Connection.new

localhost, 27017

Connection.new("localhost")

localhost, 3000, max 5 connections, with max 5 seconds of wait time.

Connection.new("localhost", 3000, :pool_size => 5, :timeout => 5)

localhost, 3000, where this node may be a slave

Connection.new("localhost", 3000, :slave_ok => true)

Parameters:

  • host. (String, Hash)
  • port (Integer) (defaults to: nil) —

    specify a port number here if only one host is being specified.

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

    a customizable set of options

Options Hash (opts):

  • :safe (Boolean, Hash) — default: false —

    Set the default safe-mode options propogated to DB objects instantiated off of this Connection. This default can be overridden upon instantiation of any DB by explicity setting a :safe value on initialization.

  • :slave_ok (Boolean) — default: false —

    Must be set to true when connecting to a single, slave node.

  • :logger (Logger, #debug) — default: nil —

    A Logger instance for debugging driver ops. Note that logging negatively impacts performance; therefore, it should not be used for high-performance apps.

  • :pool_size (Integer) — default: 1 —

    The maximum number of socket connections allowed per connection pool. Note: this setting is relevant only for multi-threaded applications.

  • :timeout (Float) — default: 5.0 —

    When all of the connections a pool are checked out, this is the number of seconds to wait for a new connection to be released before throwing an exception. Note: this setting is relevant only for multi-threaded applications (which in Ruby are rare).

Raises:

  • (ReplicaSetConnectionError) —

    This is raised if a replica set name is specified and the driver fails to connect to a replica set with that name.

See Also:



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mongo/connection.rb', line 91

def initialize(host=nil, port=nil, opts={})
  @host_to_try = format_pair(host, port)

  # Host and port of current master.
  @host = @port = nil

  # slave_ok can be true only if one node is specified
  @slave_ok = opts[:slave_ok]

  opts[:socket] = host[:socket] if host.kind_of?(Hash) && !opts[:socket]

  setup(opts)
end

Instance Attribute Details

#auths ⇒ Object (readonly)

Returns the value of attribute auths.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def auths
  @auths
end

#host_to_try ⇒ Object (readonly)

Returns the value of attribute host_to_try.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def host_to_try
  @host_to_try
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def logger
  @logger
end

#pool_size ⇒ Object (readonly)

Returns the value of attribute pool_size.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def pool_size
  @pool_size
end

#primary ⇒ Object (readonly)

Returns the value of attribute primary.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def primary
  @primary
end

#primary_pool ⇒ Object (readonly)

Returns the value of attribute primary_pool.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def primary_pool
  @primary_pool
end

#safe ⇒ Object (readonly)

Returns the value of attribute safe.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def safe
  @safe
end

#size ⇒ Object (readonly)

Returns the value of attribute size.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def size
  @size
end

#unix_socket_path ⇒ Object (readonly)

Returns the value of attribute unix_socket_path.



39
40
41
 
# File 'lib/mongo/connection.rb', line 39

def unix_socket_path
  @unix_socket_path
end

Class Method Details

.from_uri(string, extra_opts = {}) ⇒ Mongo::Connection, Mongo::ReplSetConnection

Initialize a connection to MongoDB using the MongoDB URI spec:

Parameters:

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/mongo/connection.rb', line 146

def self.from_uri(string, extra_opts={})
  uri = URIParser.new(string)
  opts = uri.connection_options
  opts.merge!(extra_opts)

  if uri.nodes.length == 1
    opts.merge!({:auths => uri.auths})
    Connection.new(uri.nodes[0][0], uri.nodes[0][1], opts)
  elsif uri.nodes.length > 1
    nodes = uri.nodes.clone
    nodes_with_opts = nodes << opts
    ReplSetConnection.new(*nodes_with_opts)
  else
    raise MongoArgumentError, "No nodes specified. Please ensure that you've provided at least one node."
  end
end

.multi(nodes, opts = {}) ⇒ Mongo::Connection

Deprecated.

DEPRECATED

Initialize a connection to a MongoDB replica set using an array of seed nodes.

The seed nodes specified will be used on the initial connection to the replica set, but note that this list of nodes will be replced by the list of canonical nodes returned by running the is_master command on the replica set.

Examples:

Connection.multi([["db1.example.com", 27017], ["db2.example.com", 27017]])

This connection will read from a random secondary node.

Connection.multi([["db1.example.com", 27017], ["db2.example.com", 27017], ["db3.example.com", 27017]],
                :read_secondary => true)

Parameters:

  • nodes (Array) —

    An array of arrays, each of which specifies a host and port.

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

    Any of the available options that can be passed to Connection.new.

Options Hash (opts):

  • :rs_name (String) — default: nil —

    The name of the replica set to connect to. An exception will be raised if unable to connect to a replica set with this name.

  • :read_secondary (Boolean) — default: false —

    When true, this connection object will pick a random slave to send reads to.

Returns:



131
132
133
134
135
136
 
# File 'lib/mongo/connection.rb', line 131

def self.multi(nodes, opts={})
  warn "Connection.multi is now deprecated. Please use ReplSetConnection.new instead."

  nodes << opts
  ReplSetConnection.new(*nodes)
end

Instance Method Details

#[](db_name) ⇒ Mongo::DB

Shortcut for returning a database. Use DB#db to accept options.

Parameters:

  • db_name (String) —

    a valid database name.

Returns:



295
296
297
 
# File 'lib/mongo/connection.rb', line 295

def [](db_name)
  DB.new(db_name, self, :safe => @safe)
end

#active? ⇒ Boolean

Determine if the connection is active. In a normal case the server_info operation will be performed without issues, but if the connection was dropped by the server or for some reason the sockets are unsynchronized, a ConnectionFailure will be raised and the return will be false.

Returns:

  • (Boolean) 


503
504
505
506
507
508
509
510
511
 
# File 'lib/mongo/connection.rb', line 503

def active?
  return false unless connected?

  ping
  true

  rescue ConnectionFailure
  false
end

#add_auth(db_name, username, password) ⇒ Hash

Save an authentication to this connection. When connecting, the connection will attempt to re-authenticate on every db specificed in the list of auths. This method is called automatically by DB#authenticate.

Note: this method will not actually issue an authentication command. To do that, either run Connection#apply_saved_authentication or DB#authenticate.

Parameters:

Returns:

  • (Hash) —

    a hash representing the authentication just added.



217
218
219
220
221
222
223
224
225
 
# File 'lib/mongo/connection.rb', line 217

def add_auth(db_name, username, password)
  remove_auth(db_name)
  auth = {}
  auth['db_name']  = db_name
  auth['username'] = username
  auth['password'] = password
  @auths << auth
  auth
end

#apply_saved_authentication(opts = {}) ⇒ Boolean

Apply each of the saved database authentications.

Returns:

  • (Boolean) —

    returns true if authentications exist and succeeed, false if none exists.

Raises:



195
196
197
198
199
200
201
202
 
# File 'lib/mongo/connection.rb', line 195

def apply_saved_authentication(opts={})
  return false if @auths.empty?
  @auths.each do |auth|
    self[auth['db_name']].issue_authentication(auth['username'], auth['password'], false,
      :socket => opts[:socket])
  end
  true
end

#authenticate_pools ⇒ Object 



249
250
251
 
# File 'lib/mongo/connection.rb', line 249

def authenticate_pools
  @primary_pool.authenticate_existing
end

#checkin_reader(socket) ⇒ Object

Checkin a socket used for reading. Note: this is overridden in ReplSetConnection.



553
554
555
556
557
 
# File 'lib/mongo/connection.rb', line 553

def checkin_reader(socket)
  if @primary_pool
    @primary_pool.checkin(socket)
  end
end

#checkin_writer(socket) ⇒ Object

Checkin a socket used for writing. Note: this is overridden in ReplSetConnection.



561
562
563
564
565
 
# File 'lib/mongo/connection.rb', line 561

def checkin_writer(socket)
  if @primary_pool
    @primary_pool.checkin(socket)
  end
end

#checkout_reader ⇒ Object

Checkout a socket for reading (i.e., a secondary node). Note: this is overridden in ReplSetConnection.



539
540
541
542
 
# File 'lib/mongo/connection.rb', line 539

def checkout_reader
  connect unless connected?
  @primary_pool.checkout
end

#checkout_writer ⇒ Object

Checkout a socket for writing (i.e., a primary node). Note: this is overridden in ReplSetConnection.



546
547
548
549
 
# File 'lib/mongo/connection.rb', line 546

def checkout_writer
  connect unless connected?
  @primary_pool.checkout
end

#clear_auths ⇒ true

Remove all authenication information stored in this connection.

Returns:

  • (true) —

    this operation return true because it always succeeds.



244
245
246
247
 
# File 'lib/mongo/connection.rb', line 244

def clear_auths
  @auths = []
  true
end

#close ⇒ Object

Close the connection to the database.



523
524
525
526
 
# File 'lib/mongo/connection.rb', line 523

def close
  @primary_pool.close if @primary_pool
  @primary_pool = nil
end

#connect ⇒ Object Also known as: reconnect

Create a new socket and attempt to connect to master. If successful, sets host and port to master and returns the socket.

If connecting to a replica set, this method will replace the initially-provided seed list with any nodes known to the set.

Raises:



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/mongo/connection.rb', line 464

def connect
  reset_connection

  config = check_is_master(@host_to_try)
  if config
    if config['ismaster'] == 1 || config['ismaster'] == true
      @read_primary = true
    elsif @slave_ok
      @read_primary = false
    end

    set_primary(@host_to_try)
  end

  if connected?
    BSON::BSON_CODER.update_max_bson_size(self)
  else
    raise ConnectionFailure, "Failed to connect to a master node at #{self.to_s}"
  end
end

#connected? ⇒ Boolean

It’s possible that we defined connected as all nodes being connected??? NOTE: Do check if this needs to be more stringent. Probably not since if any node raises a connection failure, all nodes will be closed.

Returns:

  • (Boolean) 


493
494
495
 
# File 'lib/mongo/connection.rb', line 493

def connected?
  @primary_pool && ((@primary_pool.host && @primary_pool.port) || @primary_pool.unix_socket_path )
end

#connecting? ⇒ Boolean

Returns:

  • (Boolean) 


486
487
488
 
# File 'lib/mongo/connection.rb', line 486

def connecting?
  @nodes_to_try.length > 0
end

#copy_database(from, to, from_host = "localhost", username = nil, password = nil) ⇒ Object

Copy the database from to to on localhost. The from database is assumed to be on localhost, but an alternate host can be specified.

Parameters:

  • from (String) —

    name of the database to copy from.

  • to (String) —

    name of the database to copy to.

  • from_host (String) (defaults to: "localhost") —

    host of the ‘from’ database.

  • username (String) (defaults to: nil) —

    username for authentication against from_db (>=1.3.x).

  • password (String) (defaults to: nil) —

    password for authentication against from_db (>=1.3.x).



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/mongo/connection.rb', line 314

def copy_database(from, to, from_host="localhost", username=nil, password=nil)
  oh = BSON::OrderedHash.new
  oh[:copydb]   = 1
  oh[:fromhost] = from_host
  oh[:fromdb]   = from
  oh[:todb]     = to
  if username || password
    unless username && password
      raise MongoArgumentError, "Both username and password must be supplied for authentication."
    end
    nonce_cmd = BSON::OrderedHash.new
    nonce_cmd[:copydbgetnonce] = 1
    nonce_cmd[:fromhost] = from_host
    result = self["admin"].command(nonce_cmd)
    oh[:nonce] = result["nonce"]
    oh[:username] = username
    oh[:key] = Mongo::Support.auth_key(username, password, oh[:nonce])
  end
  self["admin"].command(oh)
end

#database_info ⇒ Hash

Return a hash with all database names and their respective sizes on disk.

Returns:



261
262
263
264
265
266
 
# File 'lib/mongo/connection.rb', line 261

def database_info
  doc = self['admin'].command({:listDatabases => 1})
  doc['databases'].each_with_object({}) do |db, info|
    info[db['name']] = db['sizeOnDisk'].to_i
  end
end

#database_names ⇒ Array

Return an array of database names.

Returns:

  • (Array) 


271
272
273
 
# File 'lib/mongo/connection.rb', line 271

def database_names
  database_info.keys
end

#db(db_name, opts = {}) ⇒ Mongo::DB

Return a database with the given name. See DB#new for valid options hash parameters.

Parameters:

  • db_name (String) —

    a valid database name.

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

    options to be passed to the DB constructor.

Returns:



284
285
286
 
# File 'lib/mongo/connection.rb', line 284

def db(db_name, opts={})
  DB.new(db_name, self, opts)
end

#drop_database(name) ⇒ Object

Drop a database.

Parameters:

  • name (String) —

    name of an existing database.



302
303
304
 
# File 'lib/mongo/connection.rb', line 302

def drop_database(name)
  self[name].command(:dropDatabase => 1)
end

#instrument(name, payload = {}, &blk) ⇒ Object

Execute the block and log the operation described by name and payload. TODO: Not sure if this should take a block.



570
571
572
573
574
 
# File 'lib/mongo/connection.rb', line 570

def instrument(name, payload = {}, &blk)
  res = yield
  log_operation(name, payload)
  res
end

#lock! ⇒ BSON::OrderedHash

Fsync, then lock the mongod process against writes. Use this to get the datafiles in a state safe for snapshotting, backing up, etc.

Returns:

  • (BSON::OrderedHash) —

    the command response



167
168
169
170
171
172
 
# File 'lib/mongo/connection.rb', line 167

def lock!
  cmd = BSON::OrderedHash.new
  cmd[:fsync] = 1
  cmd[:lock]  = true
  self['admin'].command(cmd)
end

#locked? ⇒ Boolean

Is this database locked against writes?

Returns:

  • (Boolean) 


177
178
179
 
# File 'lib/mongo/connection.rb', line 177

def locked?
  self['admin']['$cmd.sys.inprog'].find_one['fsyncLock'] == 1
end

#logout_pools(db) ⇒ Object 



253
254
255
 
# File 'lib/mongo/connection.rb', line 253

def logout_pools(db)
  @primary_pool.logout_existing(db)
end

#max_bson_size ⇒ Integer

Returns the maximum BSON object size as returned by the core server. Use the 4MB default when the server doesn’t report this.

Returns:

  • (Integer) 


532
533
534
535
 
# File 'lib/mongo/connection.rb', line 532

def max_bson_size
  config = self['admin'].command({:ismaster => 1})
  config['maxBsonObjectSize'] || Mongo::DEFAULT_MAX_BSON_SIZE
end

#ping ⇒ Hash

Checks if a server is alive. This command will return immediately even if the server is in a lock.

Returns:



339
340
341
 
# File 'lib/mongo/connection.rb', line 339

def ping
  self["admin"].command({:ping => 1})
end

#read_primary? ⇒ Boolean Also known as: primary?

Determine whether we’re reading from a primary node. If false, this connection connects to a secondary node and @slave_ok is true.

Returns:

  • (Boolean) 


517
518
519
 
# File 'lib/mongo/connection.rb', line 517

def read_primary?
  @read_primary
end

#receive_message(operation, message, log_message = nil, socket = nil, command = false) ⇒ Array

Sends a message to the database and waits for the response.

Parameters:

  • operation (Integer) —

    a MongoDB opcode.

  • message (BSON::ByteBuffer) —

    a message to send to the database.

  • socket (Socket) (defaults to: nil) —

    a socket to use in lieu of checking out a new one.

Returns:

  • (Array) —

    An array whose indexes include [0] documents returned, [1] number of document received, and [3] a cursor_id.



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/mongo/connection.rb', line 432

def receive_message(operation, message, log_message=nil, socket=nil, command=false)
  request_id = add_message_headers(message, operation)
  packed_message = message.to_s
  begin
    if socket
      sock = socket
      checkin = false
    else
      sock = (command ? checkout_writer : checkout_reader)
      checkin = true
    end

    result = ''
    @safe_mutexes[sock].synchronize do
      send_message_on_socket(packed_message, sock)
      result = receive(sock, request_id)
    end
  ensure
    if checkin
      command ? checkin_writer(sock) : checkin_reader(sock)
    end
  end
  result
end

#remove_auth(db_name) ⇒ Boolean

Remove a saved authentication for this connection.

Parameters:

Returns:

  • (Boolean) 


232
233
234
235
236
237
238
239
 
# File 'lib/mongo/connection.rb', line 232

def remove_auth(db_name)
  return unless @auths
  if @auths.reject! { |a| a['db_name'] == db_name }
    true
  else
    false
  end
end

#send_message(operation, message, log_message = nil) ⇒ Integer

Send a message to MongoDB, adding the necessary headers.

Parameters:

  • operation (Integer) —

    a MongoDB opcode.

  • message (BSON::ByteBuffer) —

    a message to send to the database.

Returns:

  • (Integer) —

    number of bytes sent



372
373
374
375
376
377
378
379
380
381
 
# File 'lib/mongo/connection.rb', line 372

def send_message(operation, message, log_message=nil)
  begin
    add_message_headers(message, operation)
    packed_message = message.to_s
    socket = checkout_writer
    send_message_on_socket(packed_message, socket)
  ensure
    checkin_writer(socket)
  end
end

#send_message_with_safe_check(operation, message, db_name, log_message = nil, last_error_params = false) ⇒ Hash

Sends a message to the database, waits for a response, and raises an exception if the operation has failed.

Parameters:

  • operation (Integer) —

    a MongoDB opcode.

  • message (BSON::ByteBuffer) —

    a message to send to the database.

  • db_name (String) —

    the name of the database. used on call to get_last_error.

  • last_error_params (Hash) (defaults to: false) —

    parameters to be sent to getLastError. See DB#error for available options.

Returns:

  • (Hash) —

    The document returned by the call to getlasterror.

See Also:



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/mongo/connection.rb', line 395

def send_message_with_safe_check(operation, message, db_name, log_message=nil, last_error_params=false)
  docs = num_received = cursor_id = ''
  add_message_headers(message, operation)

  last_error_message = BSON::ByteBuffer.new
  build_last_error_message(last_error_message, db_name, last_error_params)
  last_error_id = add_message_headers(last_error_message, Mongo::Constants::OP_QUERY)

  packed_message = message.append!(last_error_message).to_s
  begin
    sock = checkout_writer
    @safe_mutexes[sock].synchronize do
      send_message_on_socket(packed_message, sock)
      docs, num_received, cursor_id = receive(sock, last_error_id)
    end
  ensure
    checkin_writer(sock)
  end

  if num_received == 1 && (error = docs[0]['err'] || docs[0]['errmsg'])
    close if error == "not master"
    error = "wtimeout" if error == "timeout"
    raise Mongo::OperationFailure, docs[0]['code'].to_s + ': ' + error
  end

  docs[0]
end

#server_info ⇒ Hash

Get the build information for the current connection.

Returns:



346
347
348
 
# File 'lib/mongo/connection.rb', line 346

def server_info
  self["admin"].command({:buildinfo => 1})
end

#server_version ⇒ Mongo::ServerVersion

Get the build version of the current server.

Returns:



355
356
357
 
# File 'lib/mongo/connection.rb', line 355

def server_version
  ServerVersion.new(server_info["version"])
end

#slave_ok? ⇒ Boolean

Is it okay to connect to a slave?

Returns:

  • (Boolean) 


362
363
364
 
# File 'lib/mongo/connection.rb', line 362

def slave_ok?
  @slave_ok
end

#to_s ⇒ Object 



576
577
578
579
580
581
582
 
# File 'lib/mongo/connection.rb', line 576

def to_s
  if @host_to_try[1]
    "#{@host_to_try[0]}:#{@host_to_try[1]}"
  else
    "#{@host_to_try[0]}"
  end
end

#unlock! ⇒ BSON::OrderedHash

Unlock a previously fsync-locked mongod process.

Returns:

  • (BSON::OrderedHash) —

    command response



184
185
186
 
# File 'lib/mongo/connection.rb', line 184

def unlock!
  self['admin']['$cmd.sys.unlock'].find_one
end