Hemera-store package
Simple API to be interoperable with most database interfaces.
Interface
Provide a unique pattern set for all common api methods. We had to choose for some conventions across document and table oriented stores.
Table-oriented | Document-oriented | Convention |
---|---|---|
Database | Database | Database |
Collection | Collection | Collection |
create
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executecreate
collection
: the name of the table or collectionstring
data
: the data which represent the entity to createobject
orArray<object>
Example:
hemera
update
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executeupdate
collection
: the name of the table or collectionstring
data
: the data which represent the entity to updateobject
query
: the search criteriaobject
Example:
hemera
updateById
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executeupdateById
collection
: the name of the table or collectionstring
data
: the data which represent the entity to createobject
id
: the primary identifier of your entitystring
ornumber
Example:
hemera
find
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executefind
collection
: the name of the table or collectionstring
query
: the search criteriaobject
options
: the search criteriaobject
(optional)limit
: maximum items to fetchinteger
offset
: the offsetinteger
orderBy
: the offsetarray<string>
orstring
ormap<string, int>
fields
: the projection settingsarray<string>
ormap<string, int>
Example:
hemera
findById
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executefindById
collection
: the name of the table or collectionstring
id
: the primary identifier of your entitystring
ornumber
Example:
hemera
remove
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executeremove
collection
: the name of the table or collectionstring
query
: the search criteriaobject
Example:
hemera
removeById
The pattern is:
topic
: is the topic to publish tosql-store
cmd
: is the command to executeremoveById
collection
: the name of the table or collectionstring
id
: the primary identifier of your entitystring
ornumber
Example:
hemera
replace
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executereplace
collection
: the name of the table or collectionstring
data
: the data which represent the entity to replaceobject
query
: the search criteriaobject
Example:
hemera
replaceById
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executereplaceById
collection
: the name of the table or collectionstring
data
: the data which represent the entity to updateobject
id
: the primary identifier of your entitystring
ornumber
Example:
hemera
exists
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executeexists
collection
: the name of the table or collectionstring
query
: the search criteriaobject
Example:
hemera
count
The pattern is:
topic
: is the store name to publish to<name>-store
cmd
: is the command to executecount
collection
: the name of the table or collectionstring
query
: the search criteriaobject
Example:
hemera