@mimik/mongooser v3.0.1

mongooser

Example

import mongodb from '@mimik/mongooser';

• mongooser
  • async
    • ~validate() ⇒ Promise
  • sync
    • ~getKMSProviders() ⇒ object
    • ~initializeSync(autoEncryption) ⇒ object
    • ~replicat() ⇒ boolean

mongooser~validate() ⇒ Promise

Database connection validation.

Kind: inner method of mongooser
Returns: Promise - .
Category: async
Throws:

• Promise Will throw an error if the database connection is not connected.

Will exit 1 if the connection request times out and the connection state is not connected.

Requires: module:@mimik/sumologic-winston-logger
Fulfil: Return null.

mongooser~getKMSProviders() ⇒ object

AutoEncryption KMSProvider.

Kind: inner method of mongooser
Returns: object - The KMSProviders object.

Will return the kmsProvider settings for the service.
Category: sync

mongooser~initializeSync(autoEncryption) ⇒ object

Database initialization.

Kind: inner method of mongooser
Returns: object - The database object.

The autoEncryption has the following strucuture:

 {
   "keyVaultClient" : <object>,
   "keyVaultNamespace": <string>, // namespace for the keyvault collection
   "kmsProviders": <object>, // KeyManager service settings
   "schemaMap": <object>, // json object for defining encryption schema
   "bypassAutoEncryption": <boolean>
 }

Check MongoDB documentation for more details. https://docs.mongodb.com/manual/reference/method/Mongo/#clientsidefieldlevelencryptionoptions

Will exit 1 if the connection request generates an error or the connection state is disconnected or disconnecting.
Category: sync
Requires: module:sumologic-winston-logger

mongooser~replicat() ⇒ boolean

Indicates if the replica is set.

Kind: inner method of mongooser
Returns: boolean - True if replica is set, False if not.
Category: sync