From 97325dd67f3b7858bd093fc161d0a56e7c7bc9bd Mon Sep 17 00:00:00 2001 From: Loïc Collignon Date: Tue, 24 Oct 2017 13:34:38 +0200 Subject: replaced store binding with a database binding based on a berkeley db MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I03978ecbf996ebc6d53a88dfd2b275051080016f Signed-off-by: Loïc Collignon --- ll-database-binding/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 ll-database-binding/README.md (limited to 'll-database-binding/README.md') diff --git a/ll-database-binding/README.md b/ll-database-binding/README.md new file mode 100644 index 0000000..fb420dc --- /dev/null +++ b/ll-database-binding/README.md @@ -0,0 +1,38 @@ + +# 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. + +* **update**: + 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. + +* **read**: + 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: +``` +{ + "key": "mykey" +} +``` + +* The **insert** and **update** verbs need a **key** and a **value** to work: +``` +{ + "key": "mykey", + "value": "my value" +} +``` +The **value** can be any valid json. -- cgit 1.2.3-korg