Inherits: IReferenceable, IConfigurable, IOpenable

Description

The MongoDbConnection class allows you to create a MongoDB connection using the official driver.

Important points

• By defining a connection and sharing it through multiple persistence components you can reduce the number of used database connections.

Configuration parameters

connection(s):

• discovery_key: (optional) key to retrieve the connection from IDiscovery
• host: host name or IP address
• port: port number (default: 27017)
• uri: resource URI or connection string with all parameters in it

credential(s):

• store_key: (optional) key to retrieve the credentials from ICredentialStore
• username: (optional) username
• password: (optional) user’s password

options:

• max_pool_size: (optional) maximum connection pool size (default: 2)
• keep_alive: (optional) enable connection keep alive (default: true)
• connect_timeout: (optional) connection timeout in milliseconds (default: 5000)
• socket_timeout: (optional) socket timeout in milliseconds (default: 360000)
• auto_reconnect: (optional) enable auto reconnection (default: true)
• reconnect_interval: (optional) reconnection interval in milliseconds (default: 1000)
• max_page_size: (optional) maximum page size (default: 100)
• replica_set: (optional) name of replica set
• ssl: (optional) enable SSL connection (default: false)
• auth_source: (optional) authentication source
• debug: (optional) enable debug output (default: false).

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
• *:discovery:*:*:1.0 - (optional) IDiscovery services
• *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials

Constructors

Creates a new instance of the connection component.

public MongoDbConnection()

Fields

_areSessionsSupported

Determines if the database supports sessions or not

private _areSessionsSupported: bool

_logger

Logger.

protected _logger: CompositeLogger

_connectionResolver

Connection resolver.

protected _connectionResolver: MongoDbConnectionResolver

_options

Configuration options.

protected _options: ConfigParams

_connection

MongoDB connection object.

protected _connection: MongoClient

_databaseName

MongoDB database name.

protected _databaseName: string

_database

MongoDB database object.

protected _database: IMongoDatabase

Instance methods

CloseAsync

Closes a component and frees used resources.

public virtual Task CloseAsync(string correlationId)

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

Configure

Configures a component by passing its configuration parameters.

public virtual void Configure(ConfigParams config)

• config: ConfigParams - configuration parameters to be set.

GetConnection

Gets the connection.

public MongoClient GetConnection()

• return: MongoClient - connection to a MongoDB database

GetDatabase

Gets the MongoDB database.

public IMongoDatabase GetDatabase()

• return: IMongoDatabase - MongoDB database

IsOpen

Checks if the component is open.

public virtual bool IsOpen()

• return: bool - true if the component is open and false otherwise.

Open

Opens the component.

public virtual Task OpenAsync(string correlationId)

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

SetReferences

Sets the references to the dependent components.

public void SetReferences(IReferences references)

• references: IReferences - references to locate the component’s dependencies.