Class: Mongo::Database

Classes and Modules

Constants

ADMIN	=	'admin'.freeze	The admin database name. @since 2.0.0
COMMAND	=	'$cmd'.freeze	The "collection" that database commands operate against. @since 2.0.0
DEFAULT_OPTIONS	=	Options::Redacted.new(:database => ADMIN).freeze	The default database options. @since 2.0.0
NAME	=	'name'.freeze	Database name field constant. @since 2.1.0
DATABASES	=	'databases'.freeze	Databases constant. @since 2.1.0
NAMESPACES	=	'system.namespaces'.freeze	The name of the collection that holds all the collection names. @since 2.0.0

Attributes

client	[R]	@return [ Client ] client The database client.
name	[R]	@return [ String ] name The name of the database.
options	[R]	@return [ Hash ] options The options.

Public Class methods

create(client)

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

@api private

@example Create a database for the client.

  Database.create(client)

@param [ Client ] client The client to create on.

@return [ Database ] The database.

@since 2.0.0

new(client, name, options = {})

Instantiate a new database object.

@example Instantiate the database.

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

@param [ Mongo::Client ] client The driver client. @param [ String, Symbol ] name The name of the database. @param [ Hash ] options The options.

@raise [ Mongo::Database::InvalidName ] If the name is nil.

@since 2.0.0

Public Instance methods

==(other)

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

@example Check database equality.

  database == other

@param [ Object ] other The object to check against.

@return [ true, false ] If the objects are equal.

@since 2.0.0

[](collection_name, options = {})

Get a collection in this database by the provided name.

@example Get a collection.

  database[:users]

@param [ String, Symbol ] collection_name The name of the collection. @param [ Hash ] options The options to the collection.

@return [ Mongo::Collection ] The collection object.

@since 2.0.0

collection(collection_name, options = {})

Alias for #[]

collection_names(options = {})

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

@example Get the collection names.

  database.collection_names

@return [ Array<String> ] The names of all non-system collections.

@since 2.0.0

collections()

Get all the collections that belong to this database.

@example Get all the collections.

  database.collections

@return [ Array<Mongo::Collection> ] All the collections.

@since 2.0.0

command(operation, opts = {})

Execute a command on the database.

@example Execute a command.

  database.command(:ismaster => 1)

@param [ Hash ] operation The command to execute. @param [ Hash ] opts The command options.

@option opts :read [ Hash ] The read preference for this command. @option opts :session [ Session ] The session to use for this command.

@return [ Hash ] The result of the command execution.

drop(options = {})

Drop the database and all its associated information.

@example Drop the database.

  database.drop

@param [ Hash ] options The options for the operation.

@option options [ Session ] :session The session to use for the operation.

@return [ Result ] The result of the command.

@since 2.0.0

fs(options = {})

Get the Grid "filesystem" for this database.

@example Get the GridFS.

  database.fs

@return [ Grid::FSBucket ] The GridFS for the database.

@since 2.0.0

inspect()

Get a pretty printed string inspection for the database.

@example Inspect the database.

  database.inspect

@return [ String ] The database inspection.

@since 2.0.0

list_collections()

Get info on all the collections in the database.

@example Get info on each collection.

  database.list_collections

@return [ Array<Hash> ] Info for each collection in the database.

@since 2.0.5

users()

Get the user view for this database.

@example Get the user view.

  database.users

@return [ View::User ] The user view.

@since 2.0.0

watch(pipeline = [], options = {})

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.

@example Get change notifications for a given database..

 database.watch([{ '$match' => { operationType: { '$in' => ['insert', 'replace'] } } }])

@param [ Array<Hash> ] pipeline Optional additional filter operators. @param [ Hash ] options The change stream options.

@option options [ String ] :full_document Allowed values: ‘default’, ‘updateLookup’.

  Defaults to 'default'. When set to 'updateLookup', the change notification for partial
  updates will include both a delta describing the changes to the document, as well as a copy
  of the entire document that was changed from some time after the change occurred.

@option options [ BSON::Document, Hash ] :resume_after Specifies the logical starting point

  for the new change stream.

@option options [ Integer ] :max_await_time_ms The maximum amount of time for the server to

  wait on new documents to satisfy a change stream query.

@option options [ Integer ] :batch_size The number of documents to return per batch. @option options [ BSON::Document, Hash ] :collation The collation to use. @option options [ Session ] :session The session to use. @option options [ BSON::Timestamp ] :start_at_operation_time Only return

  changes that occurred after the specified timestamp. Any command run
  against the server will return a cluster time that can be used here.
  Only recognized by server versions 4.0+.

@note A change stream only allows ‘majority’ read concern. @note This helper method is preferable to running a raw aggregation with a $changeStream

  stage, for the purpose of supporting resumability.

@return [ ChangeStream ] The change stream object.

@since 2.6.0

Methods

Classes and Modules

Constants

Attributes

Public Class methods

Public Instance methods