From 57376f090503d7ef5bc38f138e58e64bdea284a3 Mon Sep 17 00:00:00 2001 From: Ben Johnson Date: Sat, 8 Mar 2014 17:01:49 -0700 Subject: Rename Transaction to Tx. I changed the Transaction/RWTransaction types to Tx/RWTx, respectively. This makes the naming more consistent with other packages such as database/sql. The txnid is changed to txid as well. --- doc.go | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) (limited to 'doc.go') diff --git a/doc.go b/doc.go index d7f3ec1..ec576a2 100644 --- a/doc.go +++ b/doc.go @@ -2,7 +2,7 @@ Package bolt implements a low-level key/value store in pure Go. It supports fully serializable transactions, ACID semantics, and lock-free MVCC with multiple readers and a single writer. Bolt can be used for projects that -want a simple data store without the need to add large dependencies such as +want a simple data store without the need to add large dependencies such as Postgres or MySQL. Bolt is a single-level, zero-copy, B+tree data store. This means that Bolt is @@ -14,15 +14,14 @@ The design of Bolt is based on Howard Chu's LMDB database project. Basics -There are only a few types in Bolt: DB, Bucket, Transaction, RWTransaction, 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. +There are only a few types in Bolt: DB, Bucket, Tx, RWTx, 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. -Transactions 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. -RWTransactions provide read-write access to the database. They can create and -delete buckets and they can insert and remove keys. Only one RWTransaction is -allowed at a time. +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. Caveats -- cgit v1.2.3