const mixinafMongo::MongoConnMgr

afMongo::MongoConnMgr

Manages a pool of connections to a MongoDB instance.

Connections are created on-demand and a total of minPoolSize are kept in a pool when idle. Once the pool is exhausted, any operation requiring a connection will block for (at most) waitQueueTimeout waiting for an available connection.

This connection manager is created with the standard Mongo Connection URL in the format:

mongodb://[username:password@]host[:port][/[defaultauthdb][?options]]

Examples:

mongodb://localhost:27017
mongodb://username:password@example1.com/puppies?maxPoolSize=50

If connecting to a replica set then multiple hosts (with optional ports) may be specified:

mongodb://db1.example.net,db2.example.net:2500/?connectTimeoutMS=30000

The following URL options are supported:

minPoolSize
maxPoolSize
waitQueueTimeoutMS
connectTimeoutMS
socketTimeoutMS
w
wtimeoutMS
journal
ssl
tls
authSource
authMechanism
authMechanismProperties

URL examples:

mongodb://username:password@example1.com/database?maxPoolSize=50
mongodb://example2.com?minPoolSize=10&maxPoolSize=50&ssl=true

See https://www.mongodb.com/docs/manual/reference/connection-string/ for details.

On startup() the hosts are queried to find the primary / master node. All read and write operations are performed on the primary node.

When a connection to the master node is lost, all hosts are re-queried to find the new master.

Note this connection manager is safe for multi-threaded / web-application use.

database

Source

abstract Str? database()

The default database name, taken from the the Connection URL auth source.

leaseConn

Source

abstract Obj? leaseConn(|MongoConn->Obj? c)

Makes a connection available to the given function.

What ever is returned from the func is returned from the method.

Any IOErrs thrown in the fn are assumed to be networking errors, and invoke a topology recan and a Master failover.

log

Source

abstract Log log()

The log instance used to report warnings.

make

Source

static new make(Uri connectionUrl, Log? log := null)

Creates a pooled Mongo Connection Manager.

The following connection URL options are supported:

minPoolSize
maxPoolSize
waitQueueTimeoutMS
connectTimeoutMS
socketTimeoutMS
w
wtimeoutMS
journal
ssl
tls
authSource
authMechanism
authMechanismProperties

URL examples:

mongodb://username:password@example1.com/database?maxPoolSize=50
mongodb://example2.com?minPoolSize=10&maxPoolSize=50&ssl=true

See https://www.mongodb.com/docs/manual/reference/connection-string/.

mongoUrl

Source

abstract Uri? mongoUrl()

Basic details of where this ConnectionManager connects to, for debugging purposes. When connecting to replica sets, this should indicate the primary.

It should not contain any user credentials and should be safe to log.

shutdown

Source

abstract This shutdown()

Closes all MongoDB connections.

startup

Source

abstract This startup()

Does what ever the ConnectionManager needs to do to initialise itself.

Often this would be create database connections or other network related activity that it may not wish to do inside a ctor.

writeConcern

Source

abstract [Str:Obj?]? writeConcern()

The default write concern that all write operations should use.