Class: Mongo::Database

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/mongo/database.rb,
lib/mongo/database/view.rb

Overview

Represents a database on the db server and operations that can execute on it at this level.

Since:

  • 2.0.0

Defined Under Namespace

Classes: View

Constant Summary collapse

ADMIN =

The admin database name.

Since:

  • 2.0.0

'admin'.freeze
COMMAND =

The “collection” that database commands operate against.

Since:

  • 2.0.0

'$cmd'.freeze
DEFAULT_OPTIONS =

The default database options.

Since:

  • 2.0.0

Options::Redacted.new(:database => ADMIN).freeze
NAME =

Database name field constant.

Since:

  • 2.1.0

'name'.freeze
DATABASES =

Databases constant.

Since:

  • 2.1.0

'databases'.freeze
NAMESPACES =

The name of the collection that holds all the collection names.

Since:

  • 2.0.0

'system.namespaces'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, name, options = {}) ⇒ Database

Instantiate a new database object.

Examples:

Instantiate the database.

Mongo::Database.new(client, :test)

Parameters:

  • client (Mongo::Client) —

    The driver client.

  • name (String, Symbol) —

    The name of the database.

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

    The options.

Raises:

  • (Mongo::Database::InvalidName) —

    If the name is nil.

Since:

  • 2.0.0



185
186
187
188
189
190
 
# File 'lib/mongo/database.rb', line 185

def initialize(client, name, options = {})
  raise Error::InvalidDatabaseName.new unless name
  @client = client
  @name = name.to_s.freeze
  @options = options.freeze
end

Instance Attribute Details

#client ⇒ Client (readonly)

Returns client The database client.

Returns:

  • (Client) —

    client The database client.

Since:

  • 2.0.0



57
58
59
 
# File 'lib/mongo/database.rb', line 57

def client
  @client
end

#name ⇒ String (readonly)

Returns name The name of the database.

Returns:

  • (String) —

    name The name of the database.

Since:

  • 2.0.0



60
61
62
 
# File 'lib/mongo/database.rb', line 60

def name
  @name
end

#options ⇒ Hash (readonly)

Returns options The options.

Returns:

  • (Hash) —

    options The options.

Since:

  • 2.0.0



63
64
65
 
# File 'lib/mongo/database.rb', line 63

def options
  @options
end

Class Method Details

.create(client) ⇒ Database

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a database for the provided client, for use when we don’t want the client’s original database instance to be the same.

Examples:

Create a database for the client.

Database.create(client)

Parameters:

  • client (Client) —

    The client to create on.

Returns:

Since:

  • 2.0.0



241
242
243
244
 
# File 'lib/mongo/database.rb', line 241

def self.create(client)
  database = Database.new(client, client.options[:database], client.options)
  client.instance_variable_set(:@database, database)
end

Instance Method Details

#==(other) ⇒ true, false

Check equality of the database object against another. Will simply check if the names are the same.

Examples:

Check database equality.

database == other

Parameters:

  • other (Object) —

    The object to check against.

Returns:

  • (true, false) —

    If the objects are equal.

Since:

  • 2.0.0



82
83
84
85
 
# File 'lib/mongo/database.rb', line 82

def ==(other)
  return false unless other.is_a?(Database)
  name == other.name
end

#[](collection_name, options = {}) ⇒ Mongo::Collection Also known as: collection

Get a collection in this database by the provided name.

Examples:

Get a collection.

database[:users]

Parameters:

  • collection_name (String, Symbol) —

    The name of the collection.

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

    The options to the collection.

Returns:

Since:

  • 2.0.0



98
99
100
 
# File 'lib/mongo/database.rb', line 98

def [](collection_name, options = {})
  Collection.new(self, collection_name, options)
end

#collection_names(options = {}) ⇒ Array<String>

Get all the names of the non system collections in the database.

Examples:

Get the collection names.

database.collection_names

Returns:

  • (Array<String>) —

    The names of all non-system collections.

Since:

  • 2.0.0



111
112
113
 
# File 'lib/mongo/database.rb', line 111

def collection_names(options = {})
  View.new(self).collection_names(options)
end

#collections ⇒ Array<Mongo::Collection>

Get all the collections that belong to this database.

Examples:

Get all the collections.

database.collections

Returns:

Since:

  • 2.0.0



135
136
137
 
# File 'lib/mongo/database.rb', line 135

def collections
  collection_names.map { |name| collection(name) }
end

#command(operation, opts = {}) ⇒ Hash

Execute a command on the database.

Examples:

Execute a command.

database.command(:ismaster => 1)

Parameters:

  • operation (Hash) —

    The command to execute.

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

    The command options.

Options Hash (opts):

  • :read (Hash) —

    The read preference for this command.

Returns:

  • (Hash) —

    The result of the command execution.

Since:

  • 2.0.0



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/mongo/database.rb', line 150

def command(operation, opts = {})
  preference = ServerSelector.get(client.options.merge(opts[:read])) if opts[:read]
  server = preference ? preference.select_server(cluster, false) : cluster.next_primary(false)
  Operation::Commands::Command.new({
    :selector => operation,
    :db_name => name,
    :options => { :limit => -1 },
    :read => preference
  }).execute(server.context)
end

#drop ⇒ Result

Drop the database and all its associated information.

Examples:

Drop the database.

database.drop

Returns:

  • (Result) —

    The result of the command.

Since:

  • 2.0.0



169
170
171
 
# File 'lib/mongo/database.rb', line 169

def drop
  command(:dropDatabase => 1)
end

#fs(options = {}) ⇒ Grid::FSBucket

Get the Grid “filesystem” for this database.

Examples:

Get the GridFS.

database.fs

Returns:

Since:

  • 2.0.0



212
213
214
 
# File 'lib/mongo/database.rb', line 212

def fs(options = {})
  Grid::FSBucket.new(self, options)
end

#inspect ⇒ String

Get a pretty printed string inspection for the database.

Examples:

Inspect the database.

database.inspect

Returns:

  • (String) —

    The database inspection.

Since:

  • 2.0.0



200
201
202
 
# File 'lib/mongo/database.rb', line 200

def inspect
  "#<Mongo::Database:0x#{object_id} name=#{name}>"
end

#list_collections ⇒ Array<Hash>

Get info on all the collections in the database.

Examples:

Get info on each collection.

database.list_collections

Returns:

  • (Array<Hash>) —

    Info for each collection in the database.

Since:

  • 2.0.5



123
124
125
 
# File 'lib/mongo/database.rb', line 123

def list_collections
  View.new(self).list_collections
end

#users ⇒ View::User

Get the user view for this database.

Examples:

Get the user view.

database.users

Returns:

  • (View::User) —

    The user view.

Since:

  • 2.0.0



224
225
226
 
# File 'lib/mongo/database.rb', line 224

def users
  Auth::User::View.new(self)
end