class Mongo::Client

• Mongo::Client
• Reference
• Object

Overview

The client which provides access to a MongoDB server, replica set, or sharded cluster.

It maintains management of underlying sockets and routing to individual nodes.

Included Modules

• Mongo::WithReadConcern
• Mongo::WithReadPreference
• Mongo::WithWriteConcern

Defined in:

Constant Summary

MAX_WIRE_VERSION = 8

The maximum wire protocol version supported by this driver.

MIN_WIRE_VERSION = 6

The mininum wire protocol version supported by this driver.

Constructors

• .new(connection_string : String = "mongodb://localhost:27017")

  Create a mongodb client instance from a mongodb URL.

Instance Method Summary

• #[](name : String) : Database

  Get a newly allocated Mongo::Database for the database named name.

• #close

  Frees all the resources associated with a client.

• #command(command cmd, write_concern : WriteConcern | Nil = nil, read_concern : ReadConcern | Nil = nil, read_preference : ReadPreference | Nil = nil, server_description : SDAM::ServerDescription | Nil = nil, ignore_errors = false, **args)

  Execute a command on the server.

• #database(name : String) : Database

  Get a newly allocated Mongo::Database for the database named name.

• #list_databases(*, filter = nil, name_only : Bool | Nil = nil, authorized_databases : Bool | Nil = nil) : Commands::ListDatabases::Result

  Provides a list of all existing databases along with basic statistics about them.

• #options : Options

  The set of driver options.

• #read_concern : ReadConcern | Nil

  Read concern accessor.

• #read_concern=(read_concern : ReadConcern | Nil)

  Read concern accessor.

• #read_preference : ReadPreference | Nil

  ReadPreference accessor.

• #read_preference=(read_preference : ReadPreference | Nil)

  ReadPreference accessor.

• #status(*, repl : Int32 | Nil = nil, metrics : Int32 | Nil = nil, locks : Int32 | Nil = nil, mirrored_reads : Int32 | Nil = nil, latch_analysis : Int32 | Nil = nil) : BSON | Nil

  Returns a document that provides an overview of the database’s state.

• #top : BSON | Nil

  An administrative command that returns usage statistics for each collection.

• #watch(pipeline : Array = [] of BSON, *, full_document : String | Nil = nil, resume_after = nil, max_await_time_ms : Int64 | Nil = nil, batch_size : Int32 | Nil = nil, collation : Collation | Nil = nil, start_at_operation_time : Time | Nil = nil, start_after = nil, read_concern : ReadConcern | Nil = nil, read_preference : ReadPreference | Nil = nil) : Mongo::ChangeStream::Cursor

  Allows a client to observe all changes in a cluster.

• #write_concern : WriteConcern | Nil

  Write concern accessor.

• #write_concern=(write_concern : WriteConcern | Nil)

  Write concern accessor.

Constructor Detail

require "cryomongo"

client = Mongo::Client.new "mongodb://127.0.0.1/?appname=client-example"

Instance Method Detail

# First argument is the `Mongo::Commands`.
client.command(Mongo::Commands::DropDatabase, database: "database_name")