diff options
author | Frederic Marec <frederic.marec@iot.bzh> | 2018-09-28 09:01:04 +0200 |
---|---|---|
committer | Frédéric Marec <frederic.marec@iot.bzh> | 2018-10-09 06:41:08 +0000 |
commit | 18ca4903ffb44c858a2dd4d05c9ecf947499ac63 (patch) | |
tree | c9b9be000a5e9e8628b1cf43edffa41f83ba2b5c /README.md | |
parent | 330c932977b94db06127249ad3925d0e352b14ef (diff) |
Add tests for data persistence binding
Add test tree structures
Add tests for persistence binding
Add dependency in README.md
Change-Id: If3fa3450fa61cd7e440712354b123d02934e2488
Signed-off-by: Frederic Marec <frederic.marec@iot.bzh>
(cherry picked from commit 5663caee2540dbc769d39c1e255c35493169b037)
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 44 |
1 files changed, 29 insertions, 15 deletions
@@ -1,38 +1,52 @@ # Database Binding + This binding provide a database API with key/value semantics. The backend is currently a Berkeley DB. ## Verbs + * **insert**: - This verb insert a key/value pair in the database. - If the key already exist, the verb fails. - + + This verb insert a key/value pair in the database. + If the key already exist, the verb fails. + * **update**: - This verb update an existing record. - If the key doesn't exist, the verb fails. - + + This verb update an existing record. + If the key doesn't exist, the verb fails. + * **delete**: - This verb remove an existing key/value pair from the database. - If no matching record is found, the verb fails. + + This verb remove an existing key/value pair from the database. + If no matching record is found, the verb fails. * **read**: - This verb get the value associated with the specified key. - If no matching record is found, the verb fails. + + This verb get the value associated with the specified key. + If no matching record is found, the verb fails. ## Arguments + * The **read** and **delete** verbs need only a **key** to work: -``` + +```code { - "key": "mykey" + "key": "mykey" } ``` * The **insert** and **update** verbs need a **key** and a **value** to work: -``` + +```code { - "key": "mykey", - "value": "my value" + "key": "mykey", + "value": "my value" } ``` + The **value** can be any valid json. + +## Dependencies + +You must install BerkeleyDB and GDBM
\ No newline at end of file |