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 this._collection and this._model properties.
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.
public
MyMongoDbPersistence()
Fields
Instance methods
convertFromPublicPartial
Converts the given object from the public partial format.
protected
Document convertFromPublicPartial(Object value)
- value: Object - object to convert from the public partial format.
- returns: Document - initial object.
create
Creates a data item.
public
T create(IContext context, T item)
- context: IContext - (optional) transaction id used to trace execution through the call chain.
- item: T - item to be created.
- returns: T - created item
deleteById
Deletes a data item by it’s unique id.
public
T deleteById(IContext context, K id)
- context: IContext - (optional) a context to trace execution through a call chain.
- id: K - id of the item to be deleted
- return: T - deleted item.
deleteByIds
Deletes multiple data items by their unique ids.
public
void deleteByIds(IContext context, Listids)
- context: IContext - (optional) a context to trace execution through a call chain.
- ids: List
- ids of data items to be deleted.
getListByIds
Gets a list of data items retrieved by given unique ids.
public
ListgetListByIds(IContext context, List ids)
- context: IContext - (optional) a context to trace execution through a call chain.
- ids: List
- ids of data items to be retrieved - return: List
- data list of results by ids.
getOneById
Gets a data item by its unique id.
public
T getOneById(IContext context, K id)
- context: IContext - (optional) a context to trace execution through a call chain.
- id: K - id of data item to be retrieved.
- returns: 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.
public
T set(IContext context, T item)
- context: IContext - (optional) a context to trace execution through a call chain.
- item: T - item to be set.
- returns: T - updated item
update
Updates a data item.
public
T update(IContext context, T item)
- context: IContext - (optional) a context to trace execution through a call chain.
- item: T - item to be updated.
- returns: T - updated item.
updatePartially
Updates only few selected fields in a data item.
public
T updatePartially(IContext context, K id, AnyValueMap data)
- context: IContext - (optional) a context to trace execution through a call chain.
- id: K - id of data item to be updated.
- data: AnyValueMap - map with fields to be updated.
- returns: T - updated item.