MongoDbPersistence

_dependencyResolver

The dependency resolver.

protected _dependencyResolver: DependencyResolver

_logger

The logger.

protected _logger: CompositeLogger

_connection

The MongoDB connection component.

protected _connection: MongoDBConnection

_collectionName

The MongoDB colleciton name.

protected _collectionName: string;

_collection

The MongoDb collection object.

protected _collection: any

_client

The MongoDB connection pool object.

protected _client: any

_databaseName

The MongoDB database name.

protected _databaseName: string

_tableName

The MongoDB table name.

protected _tableName: string

_db

The MongoDb database object.

protected _db: any

_maxPageSize

The maximum number of records to return from the database per request.

protected _maxPageSize: number = 100

</span

Instance methods

clear

Clears a component’s state.

public clear(correlationId: string): Promise<void>

• correlationId: string - object to convert from the public partial format.

clearSchema

Clears all auto-created objects

protected clearSchema(): void

close

Closes the component and frees used resources.

public close(correlationId: string): Promise<void>

• correlationId: string - object to convert from the public partial format.

configure

Closes the component and frees used resources.

public configure(config: ConfigParams): void

• config: ConfigParams - configuration parameters to be set.

convertFromPublic

Converts an object value from public to internal format.

protected convertFromPublic(value: any): any

• value: any - object in public format to convert.
• returns: any - converted object in internal format.

convertToPublic

Converts and object value from internal to public format.

protected convertToPublic(value: any): any

• value: any - object in internal format to convert.
• returns: any - converted object in public format.

create

Creates a data item.

public create(correlationId: string, item: T): Promise<T>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• item: T - item to be created.
• returns: Promise<T> - created item

defineSchema

Defines the database schema

protected defineSchema(): void

deleteByFilter

This method shall be called by a public deleteByFilter method from the child class that receives FilterParams and converts them into a filter function.

public deleteByFilter(correlationId: string, filter: any): Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• filter: any - (optional) filter function used to filter items.

ensureIndex

Adds index definition to create it on opening.

protected ensureIndex(keys: any, options?: any): void

• keys: any - index keys (fields)
• options: any - index options

getCountByFilter

Gets a number of data items retrieved by a given filter.

This method shall be called by a public getCountByFilter method from the child class that receives FilterParams and converts them into a filter function.

protected getCountByFilter(correlationId: string, filter: any): Promise<number>

• correlationId: string - (optional) transaction id usedto trace execution through the call chain.
• filter: any - (optional) filter JSON object
• returns: Promise<number> - number of filtered items.

getListByFilter

Gets a list of data items retrieved by a given filter and sorted according to sort parameters.

This method shall be called by a public getListByFilter method from the child class that receives FilterParams and converts them into a filter function.

protected getListByFilter(correlationId: string, filter: any, sort: any, select: any): Promise<T[]>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• filter: any - (optional) filter function used to filter items
• sort: any - (optional) sorting parameters
• select: any - (optional) projection parameters (not used yet)
• returns: Promise<T[]> - data list of results by filter.

getOneRandom

Gets a random item from items that match to a given filter.

This method shall be called by a public getOneRandom method from the child class that receives FilterParams and converts them into a filter function.

protected getOneRandom(correlationId: string, filter: any): Promise<T>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• filter: any - fileter JSON object.
• returns: Promise<T> - random item.

getPageByFilter

Gets a page of data items retrieved by a given filter and sorted according to sort parameters.

This method shall be called by a public getPageByFilter method from the child class that receives FilterParams and converts them into a filter function.

protected getPageByFilter(correlationId: string, filter: any, paging: PagingParams, sort: any, select: any): Promise<DataPage<T>>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• filter: any - (optional) filter JSON object
• paging: PagingParams - (optional) paging parameters
• sort: any - (optional) sorting JSON object
• select: any - (optional) projection JSON object
• returns: Promise<DataPage<T>> - data page obtained by filtering

Examples

class MyMongoDbPersistence extends MongoDbPersistence<MyData> {
  public constructor() {
      super("mydata");
  }
  public async getByName(correlationId: string, name: string) {
    let criteria = { name: name };
    return await new Promise((resolve, reject) => {
       this._model.findOne(criteria, (err, item) => {
          if (err == null) resolve(item);
          else reject(err);
       });
    });
  }
  public async set(correlatonId: string, item: MyData) {
    let criteria = { name: item.name };
    let options = { upsert: true, new: true };
    return await new Promise((resolve, reject) => {
       this._model.findOneAndUpdate(criteria, item, options, (err, item) => {
          if (err == null) resolve(item);
          else reject(err);
       });
    });
  }
}

let persistence = new MyMongoDbPersistence();
persistence.configure(ConfigParams.fromTuples(
    "host", "localhost",
    "port", 27017
));

await persitence.open("123");
await persistence.set("123", { name: "ABC" });

let item = await persistence.getByName("123", "ABC");
console.log(item);                   // Result: { name: "ABC" }