An embedded key/value database for Go.

Go to file

Ben Johnson 8864050f87 Merge pull request #43 from benbjohnson/cursor-godoc-fix Fix Cursor godoc for First(), Next(), and Get().		2014-02-20 11:05:52 -07:00
LICENSE	Initial commit	2013-12-20 10:26:14 -08:00
Makefile	Add 'make cloc'.	2014-02-20 09:11:52 -07:00
NOTES	Add RWTransaction.Put().	2014-02-01 12:30:37 -05:00
README.md	Update project status.	2014-02-20 10:30:01 -07:00
TODO	Add RWTransaction.Put().	2014-02-01 12:30:37 -05:00
assert.go	Add freelist.	2014-02-10 14:04:01 -07:00
bucket.go	Add parallel usage test and race detector.	2014-02-15 21:50:34 -07:00
buckets.go	Add parallel usage test and race detector.	2014-02-15 21:50:34 -07:00
buckets_test.go	Rename sys ☞ buckets.	2014-02-05 22:15:47 -07:00
const.go	Check for sequence overflow.	2014-02-20 09:24:02 -07:00
cursor.go	Fix Cursor godoc for First(), Next(), and Get().	2014-02-20 11:04:46 -07:00
db.go	Read-only transactional block.	2014-02-16 15:43:35 -07:00
db_test.go	Add Transaction.ForEach().	2014-02-16 13:59:07 -07:00
doc.go	API Documentation.	2014-02-13 10:58:27 -07:00
error.go	Check for sequence overflow.	2014-02-20 09:24:02 -07:00
error_test.go	Add freelist.	2014-02-10 14:04:01 -07:00
example_test.go	Read-only transactional block.	2014-02-16 15:43:35 -07:00
freelist.go	API Documentation.	2014-02-13 10:58:27 -07:00
freelist_test.go	API Documentation.	2014-02-13 10:58:27 -07:00
functional_test.go	Rename errors.	2014-02-16 12:18:44 -07:00
meta.go	Rename errors.	2014-02-16 12:18:44 -07:00
meta_test.go	Rename errors.	2014-02-16 12:18:44 -07:00
node.go	Read-only transactional block.	2014-02-16 15:43:35 -07:00
node_test.go	API Documentation.	2014-02-13 10:58:27 -07:00
os.go	Add freelist.	2014-02-10 14:04:01 -07:00
os_test.go	Intermediate.	2014-01-27 10:11:54 -05:00
page.go	API Documentation.	2014-02-13 10:58:27 -07:00
page_test.go	API Documentation.	2014-02-13 10:58:27 -07:00
quick_test.go	Cursor iteration.	2014-02-11 09:07:07 -07:00
rwtransaction.go	Check for sequence overflow.	2014-02-20 09:24:02 -07:00
rwtransaction_test.go	Check for sequence overflow.	2014-02-20 09:24:02 -07:00
syscall_darwin.go	Mmap remap.	2014-02-12 11:49:57 -07:00
syscall_darwin_test.go	Mmap remap.	2014-02-12 11:49:57 -07:00
syscall_linux.go	Mmap remap.	2014-02-12 11:49:57 -07:00
syscall_linux_test.go	Mmap remap.	2014-02-12 11:49:57 -07:00
transaction.go	Add Transaction.ForEach().	2014-02-16 13:59:07 -07:00
transaction_test.go	Rename errors.	2014-02-16 12:18:44 -07:00
warn.go	Add RWTransaction.Put().	2014-02-01 12:30:37 -05:00

README.md

Bolt

Overview

Bolt is a pure Go key/value store inspired by Howard Chu and the LMDB project. The goal of the project is to provide a simple, fast, and reliable database for projects that don't require a full database server such as Postgres or MySQL. It is also meant to be educational. Most of us use tools without understanding how the underlying data really works.

Since Bolt is meant to be used as such a low-level piece of functionality, simplicity is key. The API will be small and only center around getting values and setting values. That's it. If you want to see additional functionality added then we encourage you submit a Github issue and we can discuss developing it as a separate fork.

Simple is the new beautiful.

— Tobias Lütke

Project Status

Bolt is functionally complete and has nearly full unit test coverage. The library test suite also includes randomized black box testing to ensure database consistency and thread safety. However, Bolt is a new library so it does not have significant real world usage so please use with caution and report any bugs found.

Comparing Bolt vs LMDB

Bolt is inspired by LMDB so there are many similarities between the two:

Both use a B+Tree data structure.
ACID semantics with fully serializable transactions.
Lock-free MVCC support using a single writer and multiple readers.

There are also several differences between Bolt and LMDB:

LMDB supports more additional features such as multi-value keys, fixed length keys, multi-key insert, direct writes, and bi-directional cursors. Bolt only supports basic Get(), Put(), and Delete() operations and unidirectional cursors.
LMDB databases can be shared between processes. Bolt only allows a single process to use a database at a time.
LMDB is written in C and extremely fast. Bolt is written in pure Go and, while it's fast, it is not as fast as LMDB.
LMDB is a more mature library and is used heavily in projects such as OpenLDAP.

So why use Bolt? The goal of Bolt is provide a simple, fast data store that is easily integrated into Go projects. The library does not require CGO so it is compatible with go get and you can easily build static binaries with it. We are not accepting additional functionality into the library so the API and file format are stable. Bolt also has near 100% unit test coverage and also includes heavy black box testing using the testing/quick package.

Internals

The Bolt database is meant to be a clean, readable implementation of a fast single-level key/value data store. This section gives an overview of the basic concepts and structure of the file format.

B+ Tree

Bolt uses a data structure called an append-only B+ tree to store its data. This structure allows for efficient traversal of data.

TODO: Explain better. :)