summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 29 insertions, 15 deletions
diff --git a/README.md b/README.md
index fb420dc..979d35e 100644
--- a/README.md
+++ b/README.md
@@ -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