Class MongoDBPersistenceAdapter

Implementation of {@link PersistenceAdapter} using MongoDB.

Hierarchy

MongoDBPersistenceAdapter

Implements

PersistenceAdapter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MongoDBPersistenceAdapter(config: { collectionName: string; databaseName?: string; mongoDBClient?: MongoClient; mongoURI?: string; partitionKeyGenerator?: PartitionKeyGenerator }): MongoDBPersistenceAdapter

- Defined in MongoDbPersistenceAdapter.ts:33
Parameters
- config: { collectionName: string; databaseName?: string; mongoDBClient?: MongoClient; mongoURI?: string; partitionKeyGenerator?: PartitionKeyGenerator }
  - collectionName: string
  - Optional databaseName?: string
  - Optional mongoDBClient?: MongoClient
  - Optional mongoURI?: string
  - Optional partitionKeyGenerator?: PartitionKeyGenerator
Returns MongoDBPersistenceAdapter

Properties

Protected collectionName

collectionName: string

Protected databaseName

databaseName: string

Protected mongoDB

mongoDB: Db

Protected mongoDBClient

mongoDBClient: MongoClient

Protected mongoURI

mongoURI: string

Protected partitionKeyGenerator

partitionKeyGenerator: PartitionKeyGenerator

Methods

Private checkResult

checkResult(data: any, attributesId: any): void

- Defined in MongoDbPersistenceAdapter.ts:110
Parameters
- data: any
- attributesId: any
Returns void

deleteAttributes

deleteAttributes(requestEnvelope: RequestEnvelope): Promise<void>

- Defined in MongoDbPersistenceAdapter.ts:101
Delete persistence attributes from MongoDB.

Parameters
- requestEnvelope: RequestEnvelope
  
  Request envelope used to generate partition key.
Returns Promise<void>

getAttributes

getAttributes(requestEnvelope: RequestEnvelope): Promise<Record<string, any>>

- Defined in MongoDbPersistenceAdapter.ts:67
Retrieves persistence attributes from MongoDB.

Parameters
- requestEnvelope: RequestEnvelope
  
  Request envelope used to generate partition key.
Returns Promise<Record<string, any>>

Private getMongoDBClient

getMongoDBClient(): Promise<void>

- Defined in MongoDbPersistenceAdapter.ts:50
Returns Promise<void>

saveAttributes

saveAttributes(requestEnvelope: RequestEnvelope, attributes: Record<string, any>): Promise<void>

- Defined in MongoDbPersistenceAdapter.ts:87
Saves persistence attributes to MongoDB.

Parameters
- requestEnvelope: RequestEnvelope
  
  Request envelope used to generate partition key.
- attributes: Record<string, any>
  
  Attributes to be saved to MongoDB.
Returns Promise<void>

Generated using TypeDoc