IdentifiableMongoDbPersistence<T extends IIdentifiable<K>, K>

Extends: MongoDbPersistence

Implements: IWriter<T, K>, IGetter<T, K>, ISetter

Description

The IdentifiableMongoDbPersistence class allows you to create persistance components that store data in MongoDB databases and implement a number of CRUD operations over data items with unique ids.

Important points

• The data items must implement the IIdentifiable interface.
• In basic scenarios child classes shall only override getPageByFilter, getListByFilter or deleteByFilter operations with specific filter functions. All other operations can be used out of the box.
• In complex scenarios child classes can implement additional operations by accessing the this._collection property.

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) (not used)
• reconnect_interval: (optional) reconnection interval in milliseconds (default: 1000) (not used)
• max_page_size: (optional) maximum page size (default: 100)
• replica_set: (optional) name of replica set
• ssl: (optional) enable SSL connection (default: false) (not implements in this release)
• auth_source: (optional) authentication source
• auth_user: (optional) authentication user name
• auth_password: (optional) authentication user password
• debug: (optional) enable debug output (default: false). (not used)

References

• *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
• *:discovery:*:*:1.0 - (optional) IDiscovery services
• *:credential-store:*:*:1.0 - (optional) credential stores used to resolve credentials

Constructors

Creates a new instance of the persistence component.

IdentifiableMongoDbPersistence(String? collection)

• collection: String? - (optional) collection name.

Instance methods

create

Creates a data item.

@override

Future<T?> create(String? correlationId, T? item)

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

deleteById

Deletes a data item by it’s unique id.

@override

Future<T?> deleteById(String? correlationId, K? id)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• id: K? - id of the item to be deleted
• return: Future<T?> - deleted item.

deleteByIds

Deletes multiple data items by their unique ids.

Future deleteByIds(String? correlationId, List<K> ids)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• ids: List<K> - ids of data items to be deleted.

getListByIds

Gets a list of data items retrieved by given unique ids.

Future<List<T>> getListByIds(String? correlationId, List<K> ids)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• ids: List<K> - ids of data items to be retrieved
• return: Future<List<T>> - data list of results by ids.

getOneById

Gets a data item by its unique id.

@override

Future<T?> getOneById(String? correlationId, K? id)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• id: K? - id of data item to be retrieved.
• returns: Future<T?> - data item by id.

set

Sets a data item. If the data item exists it updates it, otherwise it creates a new data item.

Future<T?> set(String? correlationId, T? item)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• item: T? - item to be set.
• returns: Future<T?> - updated item

update

Updates a data item.

Future<T> update(String? correlationId, T? item)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• item: T? - item to be updated.
• returns: Future<T?> - updated item.

updatePartially

Updates only few selected fields in a data item.

Future<T?> updatePartially(String? correlationId, K? id, AnyValueMap? data)

• correlationId: String? - (optional) transaction id used to trace execution through the call chain.
• id: K? - id of data item to be updated.
• data: AnyValueMap? - map with fields to be updated.
• returns: Future<T?> - updated item.

Examples

class MyMongoDbPersistence extends MongoDbPersistence<MyData, String> {
    MyMongoDbPersistence(): base('mydata', new MyDataMongoDbSchema());
    dynamic _composeFilter(FilterParams) {
        filter = filter ?? new FilterParams();
        var criteria = [];
        var name = filter.getAsNullableString('name');
        if (name != null)
            criteria.add({'name': name });
        return criteria.isNotNul ? {r'$and': criteria } : null;
    }
    Future<DataPage<MyData>> getPageByFilter(String? correlationId, FilterParams filter, PagingParams paging) async {
        return base.getPageByFilter(correlationId, _composeFilter(filter), paging, null);
    }
}

var persistence = MyMongoDbPersistence();
persistence.configure(ConfigParams.fromTuples([
    'host', 'localhost',
    'port', 27017
]));

await persitence.open('123');
var item = await persistence.create('123', { 'id': '1', 'name': 'ABC' });
var page = await persistence.getPageByFilter('123', FilterParams.fromTuples(['name', 'ABC']), null);
print(page.data);          // Result: { id: '1', name: 'ABC' }
item = await persistence.deleteById('123', '1');