Class MongoDBPersistenceAdapter

Implementation of PersistenceAdapter using MongoDB.

Implements

PersistenceAdapter

Index

Constructors

Methods

deleteAttributes getAttributes saveAttributes

Constructors

constructor

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

Properties

`Protected`collectionName

collectionName: string

`Protected`databaseName

databaseName: undefined | string

`Protected`mongoDB

mongoDB: undefined | Db

`Protected`mongoDBClient

mongoDBClient: undefined | MongoClient

`Protected`mongoURI

mongoURI: undefined | string

`Protected`partitionKeyGenerator

partitionKeyGenerator: PartitionKeyGenerator

Methods

deleteAttributes

deleteAttributes(requestEnvelope: RequestEnvelope): Promise<void>
Delete persistence attributes from MongoDB.
Parameters
- requestEnvelope: RequestEnvelope
  Request envelope used to generate partition key.
Returns Promise<void>
Implementation of PersistenceAdapter.deleteAttributes
- Defined in MongoDbPersistenceAdapter.ts:112

getAttributes

getAttributes(requestEnvelope: RequestEnvelope): Promise<Record<string, any>>
Retrieves persistence attributes from MongoDB.
Parameters
- requestEnvelope: RequestEnvelope
  Request envelope used to generate partition key.
Returns Promise<Record<string, any>>
Implementation of PersistenceAdapter.getAttributes
- Defined in MongoDbPersistenceAdapter.ts:68

saveAttributes

saveAttributes(
requestEnvelope: RequestEnvelope,
attributes: Record<string, any>,
): Promise<void>
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>
Implementation of PersistenceAdapter.saveAttributes
- Defined in MongoDbPersistenceAdapter.ts:91