diff options
author | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2018-10-11 12:36:31 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@automotivelinux.org> | 2018-10-11 12:36:31 +0000 |
commit | 9b4d200e551594cb05ae747ecd8f075a545766bc (patch) | |
tree | 2e31fb6d92a1d9919af24f5ee604afa2ceca436a /README.md | |
parent | 78516d149ad32014fbff8fd007c7cea99966c0df (diff) | |
parent | 18ca4903ffb44c858a2dd4d05c9ecf947499ac63 (diff) |
Merge "Add tests for data persistence binding" into flounder
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 |