MongoDB connection using the official driver.
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
NewMongoDbConnection
Creates a new instance of the connection component.
NewMongoDbConnection() *MongoDbConnection
Fields
Logger
The logger.
Logger: *CompositeLogger
ConnectionResolver
The connection resolver.
ConnectionResolver: *MongoDbConnectionResolver
Options
The configuration options.
Options: *ConfigParams
Connection
The MongoDB connection object.
Connection: *mongodrv.Client
DatabaseName
The MongoDB database name.
DatabaseName: string
Db
The MongoDB database object.
Db: *mongodrv.Database
Methods
Close
Closes a component and frees used resources.
(c *MongoDbConnection) Close(ctx context.Context, correlationId string) error
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id used to trace execution through the call chain.
- returns: error - error or nil no errors occured.
Configures a component by passing its configuration parameters.
(c *MongoDbConnection) Configure(ctx context.Context, config *cconf.ConfigParams)
- ctx: context.Context - operation context.
- config: *cconf.ConfigParams - configuration parameters to be set.
GetConnection
Gets the connection.
(c *MongoDbConnection) GetConnection() *mongodrv.Client
- return: *mongodrv.Client - connection to a MongoDB database
GetDatabase
Gets the MongoDB database.
(c *MongoDbConnection) GetDatabase() *mongodrv.Database
- return: *mongodrv.Database - MongoDB database
IsOpen
Checks if the component is opened.
(c *MongoDbConnection) IsOpen() bool
- return: bool - True if the component has been opened and False otherwise.
Open
Opens the component.
(c *MongoDbConnection) Open(ctx context.Context, correlationId string) error
- ctx: context.Context - operation context.
- correlationId: string - (optional) transaction id used to trace execution through the call chain.
- returns: error - error or nil no errors occured.
SetReferences
Sets the references to the dependent components.
(c *MongoDbConnection) SetReferences(ctx context.Context, references crefer.IReferences)
- ctx: context.Context - operation context.
- references: crefer.IReferences - references to locate the component dependencies.