Class: Mongo::Connection

Inherits:

Object

• Object
• Mongo::Connection

show all

Includes:

Logging, Networking

Defined in:

lib/mongo/connection.rb

Overview

Constant Summary

TCPSocket =

Mongo::TCPSocket

Mutex =

::Mutex

ConditionVariable =

::ConditionVariable

DEFAULT_PORT =

27017

GENERIC_OPTS =

[:ssl, :auths, :pool_size, :pool_timeout, :timeout, :op_timeout, :connect_timeout, :safe, :logger, :connect]

CONNECTION_OPTS =

[:slave_ok]

Constants included from Networking

Networking::BINARY_ENCODING, Networking::RESPONSE_HEADER_SIZE, Networking::STANDARD_HEADER_SIZE

Constants included from Logging

Logging::DEBUG_LEVEL

Instance Attribute Summary (collapse)

• - (Object) auths readonly

  Returns the value of attribute auths.

• - (Object) connect_timeout readonly

  Returns the value of attribute connect_timeout.

• - (Object) host_to_try readonly

  Returns the value of attribute host_to_try.

• - (Object) logger readonly

  Returns the value of attribute logger.

• - (Object) op_timeout readonly

  Returns the value of attribute op_timeout.

• - (Object) pool_size readonly

  Returns the value of attribute pool_size.

• - (Object) pool_timeout readonly

  Returns the value of attribute pool_timeout.

• - (Object) primary readonly

  Returns the value of attribute primary.

• - (Object) primary_pool readonly

  Returns the value of attribute primary_pool.

• - (Object) safe readonly

  Returns the value of attribute safe.

• - (Object) size readonly

  Returns the value of attribute size.

• - (Object) socket_class readonly

  Returns the value of attribute socket_class.

Class Method Summary (collapse)

• + (Mongo::Connection, Mongo::ReplSetConnection) from_uri(string, extra_opts = {})

  Initialize a connection to MongoDB using the MongoDB URI spec:.

• + (Mongo::Connection) multi(nodes, opts = {}) Deprecated Deprecated.

Instance Method Summary (collapse)

• - (Mongo::DB) [](db_name)

  Shortcut for returning a database.

• - (Boolean) active?

  Determine if the connection is active.

• - (Hash) add_auth(db_name, username, password)

  Save an authentication to this connection.

• - (Boolean) apply_saved_authentication(opts = {})

  Apply each of the saved database authentications.

• - (Object) authenticate_pools
• - (Object) best_available_socket

  Excecutes block with the best available socket.

• - (Object) checkin(socket)

  Check a socket back into its pool.

• - (Object) checkin_reader(socket)

  Checkin a socket used for reading.

• - (Object) checkin_writer(socket)

  Checkin a socket used for writing.

• - (Object) checkout_best

  Prefer primary pool but fall back to secondary.

• - (Object) checkout_reader

  Checkout a socket for reading (i.e., a secondary node).

• - (Object) checkout_writer

  Checkout a socket for writing (i.e., a primary node).

• - (true) clear_auths

  Remove all authenication information stored in this connection.

• - (Object) close

  Close the connection to the database.

• - (Object) connect (also: #reconnect)

  Create a new socket and attempt to connect to master.

• - (Boolean) connected?

  It's possible that we defined connected as all nodes being connected??? NOTE: Do check if this needs to be more stringent.

• - (Object) copy_database(from, to, from_host = "localhost", username = nil, password = nil)

  Copy the database from to to on localhost.

• - (Hash) database_info

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

• - (Array) database_names

  Return an array of database names.

• - (Mongo::DB) db(db_name, opts = {})

  Return a database with the given name.

• - (Object) drop_database(name)

  Drop a database.

• - (String) host

  The host name used for this connection.

• - (Connection) initialize(host = nil, port = nil, opts = {}) constructor

  Create a connection to single MongoDB instance.

• - (BSON::OrderedHash) lock!

  Fsync, then lock the mongod process against writes.

• - (Boolean) locked?

  Is this database locked against writes?.

• - (Object) logout_pools(db)
• - (Integer) max_bson_size

  Returns the maximum BSON object size as returned by the core server.

• - (Hash) ping

  Checks if a server is alive.

• - (Integer) port

  The port used for this connection.

• - (Mongo::Pool) read_pool

  The socket pool that this connection reads from.

• - (Object) read_preference

  The value of the read preference.

• - (Boolean) read_primary? (also: #primary?)

  Determine whether we're reading from a primary node.

• - (Boolean) remove_auth(db_name)

  Remove a saved authentication for this connection.

• - (Hash) server_info

  Get the build information for the current connection.

• - (Mongo::ServerVersion) server_version

  Get the build version of the current server.

• - (Boolean) slave_ok?

  Is it okay to connect to a slave?.

• - (BSON::OrderedHash) unlock!

  Unlock a previously fsync-locked mongod process.

Methods included from Networking

#new_binary_string, #receive_message, #send_message, #send_message_with_safe_check

Methods included from Logging

#instrument, #log, #write_logging_startup_message

Connection.new

Connection.new("localhost")

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

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

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

# File 'lib/mongo/connection.rb', line 97

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

  # Host and port of current master.
  @host = @port = nil
  
  # Default maximum BSON object size
  @max_bson_size = Mongo::DEFAULT_MAX_BSON_SIZE
  
  # Lock for request ids.
  @id_lock = Mutex.new
  
  # Connection pool for primay node
  @primary      = nil
  @primary_pool = nil

  check_opts(opts)
  setup(opts)
end

41
42
43

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

def auths
  @auths
end

41
42
43

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

def connect_timeout
  @connect_timeout
end

41
42
43

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

def host_to_try
  @host_to_try
end

41
42
43

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

def logger
  @logger
end

41
42
43

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

def op_timeout
  @op_timeout
end

41
42
43

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

def pool_size
  @pool_size
end

41
42
43

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

def pool_timeout
  @pool_timeout
end

41
42
43

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

def primary
  @primary
end

41
42
43

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

def primary_pool
  @primary_pool
end

41
42
43

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

def safe
  @safe
end

41
42
43

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

def size
  @size
end

41
42
43

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

def socket_class
  @socket_class
end

158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

# File 'lib/mongo/connection.rb', line 158

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

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

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

143
144
145
146
147
148

# File 'lib/mongo/connection.rb', line 143

def self.multi(nodes, opts={})
  warn "Connection.multi is now deprecated and will be removed in v2.0. Please use ReplSetConnection.new instead."

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

321
322
323

# File 'lib/mongo/connection.rb', line 321

def [](db_name)
  DB.new(db_name, self)
end

433
434
435
436
437
438
439
440
441

# File 'lib/mongo/connection.rb', line 433

def active?
  return false unless connected?

  ping
  true

  rescue ConnectionFailure
  false
end

243
244
245
246
247
248
249
250
251

# File 'lib/mongo/connection.rb', line 243

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

221
222
223
224
225
226
227
228

# File 'lib/mongo/connection.rb', line 221

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

275
276
277

# File 'lib/mongo/connection.rb', line 275

def authenticate_pools
  @primary_pool.authenticate_existing
end

523
524
525
526
527
528
529
530
531
532
533

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

def best_available_socket
  socket = nil
  begin
    socket = checkout_best
    yield socket
  ensure
    if socket
      socket.pool.checkin(socket)
    end
  end
end

516
517
518
519
520

# File 'lib/mongo/connection.rb', line 516

def checkin(socket)
  if @primary_pool && socket
    socket.pool.checkin(socket)
  end
end

505
506
507

# File 'lib/mongo/connection.rb', line 505

def checkin_reader(socket)
  checkin(socket)
end

511
512
513

# File 'lib/mongo/connection.rb', line 511

def checkin_writer(socket)
  checkin(socket)
end

484
485
486
487

# File 'lib/mongo/connection.rb', line 484

def checkout_best
  connect unless connected?
  @primary_pool.checkout
end

491
492
493
494

# File 'lib/mongo/connection.rb', line 491

def checkout_reader
  connect unless connected?
  @primary_pool.checkout
end

498
499
500
501

# File 'lib/mongo/connection.rb', line 498

def checkout_writer
  connect unless connected?
  @primary_pool.checkout
end

270
271
272
273

# File 'lib/mongo/connection.rb', line 270

def clear_auths
  @auths = []
  true
end

469
470
471
472
473

# File 'lib/mongo/connection.rb', line 469

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

399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417

# File 'lib/mongo/connection.rb', line 399

def connect
  close

  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

    @max_bson_size = config['maxBsonObjectSize'] || Mongo::DEFAULT_MAX_BSON_SIZE
    set_primary(@host_to_try)
  end

  if !connected?
    raise ConnectionFailure, "Failed to connect to a master node at #{@host_to_try[0]}:#{@host_to_try[1]}"
  end
end

423
424
425

# File 'lib/mongo/connection.rb', line 423

def connected?
  @primary_pool && !@primary_pool.closed?
end

340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359

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

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

287
288
289
290
291
292

# File 'lib/mongo/connection.rb', line 287

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

297
298
299

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

def database_names
  database_info.keys
end

310
311
312

# File 'lib/mongo/connection.rb', line 310

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

328
329
330

# File 'lib/mongo/connection.rb', line 328

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

178
179
180

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

def host
  @primary_pool.host
end

193
194
195
196
197
198

# File 'lib/mongo/connection.rb', line 193

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

203
204
205

# File 'lib/mongo/connection.rb', line 203

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

279
280
281

# File 'lib/mongo/connection.rb', line 279

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

479
480
481

# File 'lib/mongo/connection.rb', line 479

def max_bson_size
  @max_bson_size
end

365
366
367

# File 'lib/mongo/connection.rb', line 365

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

185
186
187

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

def port
  @primary_pool.port
end

455
456
457

# File 'lib/mongo/connection.rb', line 455

def read_pool
  @primary_pool
end

460
461
462
463
464
465
466

# File 'lib/mongo/connection.rb', line 460

def read_preference
  if slave_ok?
    :secondary
  else
    :primary
  end
end

447
448
449

# File 'lib/mongo/connection.rb', line 447

def read_primary?
  @read_primary
end

258
259
260
261
262
263
264
265

# File 'lib/mongo/connection.rb', line 258

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

372
373
374

# File 'lib/mongo/connection.rb', line 372

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

381
382
383

# File 'lib/mongo/connection.rb', line 381

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

388
389
390

# File 'lib/mongo/connection.rb', line 388

def slave_ok?
  @slave_ok
end

210
211
212

# File 'lib/mongo/connection.rb', line 210

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