diff options
author | Ben Johnson <benbjohnson@yahoo.com> | 2014-03-08 20:25:37 -0700 |
---|---|---|
committer | Ben Johnson <benbjohnson@yahoo.com> | 2014-03-08 20:40:48 -0700 |
commit | c551e45a4722f58dc4c19f9d1b80b0b8db3ad039 (patch) | |
tree | 93ac43914f9cd20c8eea13f18105e55026a7ea8d /doc.go | |
parent | Rename Transaction to Tx. (diff) | |
download | dedo-c551e45a4722f58dc4c19f9d1b80b0b8db3ad039.tar.gz dedo-c551e45a4722f58dc4c19f9d1b80b0b8db3ad039.tar.xz |
Consolidate Tx and RWTx.
Diffstat (limited to 'doc.go')
-rw-r--r-- | doc.go | 11 |
1 files changed, 6 insertions, 5 deletions
@@ -14,14 +14,15 @@ The design of Bolt is based on Howard Chu's LMDB database project. Basics -There are only a few types in Bolt: DB, Bucket, Tx, RWTx, and Cursor. The DB is +There are only a few types in Bolt: DB, Bucket, Tx, and Cursor. The DB is a collection of buckets and is represented by a single file on disk. A bucket is a collection of unique keys that are associated with values. -Txs provide read-only access to data inside the database. They can retrieve -key/value pairs and can use Cursors to iterate over the entire dataset. RWTxs -provide read-write access to the database. They can create and delete buckets -and they can insert and remove keys. Only one RWTx is allowed at a time. +Transactions provide either read-only or read-write access to the database. +Read-only transactions can retrieve key/value pairs and can use Cursors to +iterate over the dataset sequentially. Read-write transactions can create and +delete buckets and can insert and remove keys. Only one read-write transaction +is allowed at a time. Caveats |