aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md40
1 files changed, 27 insertions, 13 deletions
diff --git a/README.md b/README.md
index d2b9fd4..7c61360 100644
--- a/README.md
+++ b/README.md
@@ -96,31 +96,45 @@ Cursors provide access to a specific bucket within a transaction.
```go
t, err := db.Transaction()
-b, err := t.Bucket("widgets")
-c, err := b.Cursor()
+c, err := b.Cursor("widgets")
```
#### Creating a read/write cursor
```go
t, err := db.RWTransaction()
-b, err := t.Bucket("widgets")
-c, err := b.RWCursor()
+c, err := t.RWCursor("widgets")
```
+#### Iterating over a cursor
+```go
+for k, v, err := c.First(); k != nil; k, v, err = c.Next() {
+ if err != nil {
+ return err
+ }
+ ... DO SOMETHING ...
+}
+```
+
+#### Retrieve a value for a specific key
-* Cursor
+```go
+value, err := c.Get([]byte("foo"))
+value, err := c.GetString("foo")
+```
+#### Set the value for a key (RWCursor only)
+```go
+err := c.Put([]byte("foo"), []byte("bar"))
+err := c.PutString("foo", "bar")
```
-DB
-Bucket
-Transaction / RWTransaction
-Cursor / RWCursor
-page
-meta
-branchNode
-leafNode
+#### Delete a given key
+
+```go
+err := c.Delete([]byte("foo"))
+err := c.DeleteString("foo")
```
+