diff options
| author | Ben Johnson <benbjohnson@yahoo.com> | 2014-01-21 14:37:55 -0700 |
|---|---|---|
| committer | Ben Johnson <benbjohnson@yahoo.com> | 2014-01-21 15:00:48 -0700 |
| commit | bce3e667dff9d6ab51f4e37bc79ef961e36bfb31 (patch) | |
| tree | 1ba0fc541a5d729590b9e43a0d9072fe7d027a05 /README.md | |
| parent | Refactoring to RWCursor, RWTxn, and branch/leaf nodes and pages. (diff) | |
| download | dedo-bce3e667dff9d6ab51f4e37bc79ef961e36bfb31.tar.gz dedo-bce3e667dff9d6ab51f4e37bc79ef961e36bfb31.tar.xz | |
Intermediate commit.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
@@ -1,4 +1,38 @@ bolt ==== +## Overview + A low-level key/value database for Go. + + +## API + +### DB + +### Creating a database + +``` +db := DB() +err := db.Open("/path/to/db", 0666) +... +err := db.Close() +``` + +### Creating a bucket + + +* Cursor + + +``` +DB +Bucket +Transaction / RWTransaction +Cursor / RWCursor + +page +meta +branchNode +leafNode +``` |