Class: Mongo::Database
- Inherits:
-
Object
- Object
- Mongo::Database
- Extended by:
- Forwardable
- Includes:
- Retryable
- Defined in:
- build/ruby-driver-master/lib/mongo/database.rb,
build/ruby-driver-master/lib/mongo/database/view.rb
Overview
Represents a database on the db server and operations that can execute on it at this level.
Defined Under Namespace
Classes: View
Constant Summary collapse
- ADMIN =
The admin database name.
'admin'.freeze
- COMMAND =
The “collection” that database commands operate against.
'$cmd'.freeze
- DEFAULT_OPTIONS =
The default database options.
Options::Redacted.new(:database => ADMIN).freeze
- NAME =
Deprecated.
Database name field constant.
'name'.freeze
- DATABASES =
Databases constant.
'databases'.freeze
- NAMESPACES =
The name of the collection that holds all the collection names.
'system.namespaces'.freeze
Instance Attribute Summary collapse
-
#client ⇒ Client
readonly
Client The database client.
-
#name ⇒ String
readonly
Name The name of the database.
-
#options ⇒ Hash
readonly
Options The options.
Class Method Summary collapse
-
.create(client) ⇒ Database
private
Create a database for the provided client, for use when we don’t want the client’s original database instance to be the same.
Instance Method Summary collapse
-
#==(other) ⇒ true, false
Check equality of the database object against another.
-
#[](collection_name, options = {}) ⇒ Mongo::Collection
(also: #collection)
Get a collection in this database by the provided name.
-
#aggregate(pipeline, options = {}) ⇒ Aggregation
Perform an aggregation on the database.
-
#cluster ⇒ Mongo::Server
Get the primary server from the cluster.
-
#collection_names(options = {}) ⇒ Array<String>
Get all the names of the non-system collections in the database.
-
#collections(options = {}) ⇒ Array<Mongo::Collection>
Get all the non-system collections that belong to this database.
-
#command(operation, opts = {}) ⇒ Mongo::Operation::Result
Execute a command on the database.
-
#drop(options = {}) ⇒ Result
Drop the database and all its associated information.
-
#fs(options = {}) ⇒ Grid::FSBucket
Get the Grid “filesystem” for this database.
-
#initialize(client, name, options = {}) ⇒ Database
constructor
Instantiate a new database object.
-
#inspect ⇒ String
Get a pretty printed string inspection for the database.
-
#list_collections(options = {}) ⇒ Array<Hash>
Get info on all the non-system collections in the database.
-
#read_command(operation, opts = {}) ⇒ Hash
private
Execute a read command on the database, retrying the read if necessary.
-
#users ⇒ View::User
Get the user view for this database.
-
#watch(pipeline = [], options = {}) ⇒ ChangeStream
As of version 3.6 of the MongoDB server, a “$changeStream“ pipeline stage is supported in the aggregation framework.
Methods included from Retryable
#legacy_write_with_retry, #nro_write_with_retry, #read_with_one_retry, #read_with_retry, #read_with_retry_cursor, #write_with_retry
Constructor Details
#initialize(client, name, options = {}) ⇒ Database
Instantiate a new database object.
315 316 317 318 319 320 321 322 323 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 315 def initialize(client, name, = {}) raise Error::InvalidDatabaseName.new unless name if Lint.enabled? && !(name.is_a?(String) || name.is_a?(Symbol)) raise "Database name must be a string or a symbol: #{name}" end @client = client @name = name.to_s.freeze @options = .freeze end |
Instance Attribute Details
#client ⇒ Client (readonly)
Returns client The database client.
62 63 64 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 62 def client @client end |
#name ⇒ String (readonly)
Returns name The name of the database.
65 66 67 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 65 def name @name end |
#options ⇒ Hash (readonly)
Returns options The options.
68 69 70 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 68 def @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.
464 465 466 467 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 464 def self.create(client) database = Database.new(client, client.[:database], client.) 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.
93 94 95 96 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 93 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.
109 110 111 112 113 114 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 109 def [](collection_name, = {}) if [:server_api] raise ArgumentError, 'The :server_api option cannot be specified for collection objects. It can only be specified on Client level' end Collection.new(self, collection_name, ) end |
#aggregate(pipeline, options = {}) ⇒ Aggregation
Perform an aggregation on the database.
402 403 404 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 402 def aggregate(pipeline, = {}) View.new(self).aggregate(pipeline, ) end |
#cluster ⇒ Mongo::Server
Returns Get the primary server from the cluster.
79 80 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 79 def_delegators :cluster, :next_primary |
#collection_names(options = {}) ⇒ Array<String>
The set of returned collection names depends on the version of MongoDB server that fulfills the request.
Get all the names of the non-system collections in the database.
137 138 139 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 137 def collection_names( = {}) View.new(self).collection_names() end |
#collections(options = {}) ⇒ Array<Mongo::Collection>
The set of returned collections depends on the version of MongoDB server that fulfills the request.
Get all the non-system collections that belong to this database.
190 191 192 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 190 def collections( = {}) collection_names().map { |name| collection(name) } end |
#command(operation, opts = {}) ⇒ Mongo::Operation::Result
Execute a command on the database.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 212 def command(operation, opts = {}) opts = opts.dup execution_opts = opts.delete(:execution_options) || {} txn_read_pref = if opts[:session] && opts[:session].in_transaction? opts[:session].txn_read_preference else nil end txn_read_pref ||= opts[:read] || ServerSelector::PRIMARY Lint.validate_underscore_read_preference(txn_read_pref) selector = ServerSelector.get(txn_read_pref) client.send(:with_session, opts) do |session| server = selector.select_server(cluster, nil, session) op = Operation::Command.new( :selector => operation.dup, :db_name => name, :read => selector, :session => session ) op.execute(server, context: Operation::Context.new(client: client, session: session), options: execution_opts) end end |
#drop(options = {}) ⇒ Result
Drop the database and all its associated information.
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 286 def drop( = {}) operation = { :dropDatabase => 1 } client.send(:with_session, ) do |session| write_concern = if [:write_concern] WriteConcern.get([:write_concern]) else self.write_concern end Operation::DropDatabase.new({ selector: operation, db_name: name, write_concern: write_concern, session: session }).execute(next_primary(nil, session), context: Operation::Context.new(client: client, session: session)) end end |
#fs(options = {}) ⇒ Grid::FSBucket
Get the Grid “filesystem” for this database.
357 358 359 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 357 def fs( = {}) Grid::FSBucket.new(self, ) end |
#inspect ⇒ String
Get a pretty printed string inspection for the database.
333 334 335 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 333 def inspect "#<Mongo::Database:0x#{object_id} name=#{name}>" end |
#list_collections(options = {}) ⇒ Array<Hash>
The set of collections returned, and the schema of the information hash per collection, depends on the MongoDB server version that fulfills the request.
Get info on all the non-system collections in the database.
166 167 168 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 166 def list_collections( = {}) View.new(self).list_collections() end |
#read_command(operation, opts = {}) ⇒ Hash
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.
Execute a read command on the database, retrying the read if necessary.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 250 def read_command(operation, opts = {}) txn_read_pref = if opts[:session] && opts[:session].in_transaction? opts[:session].txn_read_preference else nil end txn_read_pref ||= opts[:read] || ServerSelector::PRIMARY Lint.validate_underscore_read_preference(txn_read_pref) preference = ServerSelector.get(txn_read_pref) client.send(:with_session, opts) do |session| read_with_retry(session, preference) do |server| Operation::Command.new( selector: operation.dup, db_name: name, read: preference, session: session, comment: opts[:comment], ).execute(server, context: Operation::Context.new(client: client, session: session)) end end end |
#users ⇒ View::User
Get the user view for this database.
369 370 371 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 369 def users Auth::User::View.new(self) end |
#watch(pipeline = [], options = {}) ⇒ ChangeStream
A change stream only allows ‘majority’ read concern.
This helper method is preferable to running a raw aggregation with a $changeStream stage, for the purpose of supporting resumability.
As of version 3.6 of the MongoDB server, a “$changeStream“ pipeline stage is supported in the aggregation framework. As of version 4.0, this stage allows users to request that notifications are sent for all changes that occur in the client’s database.
443 444 445 446 447 448 449 |
# File 'build/ruby-driver-master/lib/mongo/database.rb', line 443 def watch(pipeline = [], = {}) Mongo::Collection::View::ChangeStream.new( Mongo::Collection::View.new(collection("#{COMMAND}.aggregate")), pipeline, Mongo::Collection::View::ChangeStream::DATABASE, ) end |