MongoDbConnection

MongoDB connection using the official driver.

Implements: 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.

MongoDbConnection()

Fields

logger

Logger.

logger: CompositeLogger

connectionResolver

Connection resolver.

connectionResolver: MongoDbConnectionResolver

options

The configuration options.

options: ConfigParams

connection

MongoDB database object.

connection: mongo.Db?

databaseName

MongoDB database name.

databaseName: String?

Instance methods

close

Closes a component and frees used resources.

@override

Future close(IContext? context)

  • context: IContext - (optional) a context to trace execution through a call chain.

configure

Configures a component by passing its configuration parameters.

@override

void configure(ConfigParams config)

  • config: ConfigParams - configuration parameters to be set.

getConnection

Gets the connection.

@override

dynamic getConnection()

  • return: dynamic - connection to a MongoDB database

getDatabase

Gets the MongoDB database.

String? getDatabaseName()

  • return: String? - MongoDB database

isOpen

Checks if the component is open.

@override

bool isOpen()

  • return: bool - True if the component is open and False otherwise.

open

Opens the component.

@override

Future open(IContext? context)

  • context: IContext - (optional) a context to trace execution through a call chain.

setReferences

Sets the references to the dependent components.

@override

void setReferences(IReferences references)

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