hak5
/
bolt
mirror of https://github.com/hak5/bolt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
An embedded key/value database for Go.
164 Commits
1 Branch
9 Tags
1.5 MiB
Go 99.9%
Makefile 0.1%
 
 
Go to file
Tommi Virtanen bfb02aec20 Check meta page write error in Commit 2014-03-23 13:27:36 -07:00
cmd/bolt Fix print. 2014-03-21 23:07:46 -06:00
.gitignore Add benchmarks. 2014-03-04 13:23:46 -07:00
LICENSE Initial commit 2013-12-20 10:26:14 -08:00
Makefile Add benchmarks. 2014-03-04 13:23:46 -07:00
README.md README 2014-03-10 15:03:26 -07:00
bolt.go Minor refactor. 2014-02-28 15:13:07 -07:00
bucket.go Add ErrTxClosed error. 2014-03-23 12:20:16 -06:00
bucket_test.go Remove ease-of-use functions from the DB type. 2014-03-21 09:52:01 -06: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 Add ErrTxClosed error. 2014-03-23 12:20:16 -06:00
db.go Mark Do()/With() transaction as managed. 2014-03-23 10:34:53 -06:00
db_test.go Mark Do()/With() transaction as managed. 2014-03-23 10:34:53 -06:00
doc.go Consolidate Tx and RWTx. 2014-03-08 20:40:48 -07:00
error.go Add ErrTxClosed error. 2014-03-23 12:20:16 -06:00
error_test.go Add freelist. 2014-02-10 14:04:01 -07:00
example_test.go Remove ease-of-use functions from the DB type. 2014-03-21 09:52:01 -06:00
freelist.go Add 'bolt pages'. 2014-03-21 22:34:54 -06:00
freelist_test.go Rename Transaction to Tx. 2014-03-08 17:04:02 -07:00
functional_test.go Remove ease-of-use functions from the DB type. 2014-03-21 09:52:01 -06:00
meta.go Consolidate Tx and RWTx. 2014-03-08 20:40:48 -07:00
meta_test.go Rename errors. 2014-02-16 12:18:44 -07:00
node.go Consolidate Tx and RWTx. 2014-03-08 20:40:48 -07:00
node_test.go API Documentation. 2014-02-13 10:58:27 -07:00
page.go Add 'bolt pages'. 2014-03-21 22:34:54 -06:00
page_test.go API Documentation. 2014-02-13 10:58:27 -07:00
quick_test.go Minor refactor. 2014-02-28 15:13:07 -07:00
syscall.go Consolidate syscall files. 2014-03-23 08:59:45 -07:00
syscall_linux.go Consolidate syscall files. 2014-03-23 08:59:45 -07:00
tx.go Check meta page write error in Commit 2014-03-23 13:27:36 -07:00
tx_test.go Add ErrTxClosed error. 2014-03-23 12:20:16 -06:00

README.md

Bolt Build Status Coverage Status GoDoc Project status

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. Bolt is currently in use in a few project, however, it is still at a beta stage 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:

  1. Both use a B+Tree data structure.

  2. ACID semantics with fully serializable transactions.

  3. Lock-free MVCC support using a single writer and multiple readers.

There are also several differences between Bolt and LMDB:

  1. LMDB supports more additional features such as multi-value keys, fixed length keys, multi-key insert, and direct writes. Bolt only supports basic Get(), Put(), and Delete() operations and bidirectional cursors.

  2. LMDB databases can be shared between processes. Bolt only allows a single process access.

  3. LMDB is written in C and extremely fast. Bolt is fast but not as fast as LMDB.

  4. 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. :)

Pages

Bolt stores its data in discrete units called pages. The page size can be configured but is typically between 4KB and 32KB.

There are several different types of pages:

  • Meta pages - The first two pages in a database are meta pages. These are used to store references to root pages for system buckets as well as keep track of the last transaction identifier.

  • Branch pages - These pages store references to the location of deeper branch pages or leaf pages.

  • Leaf pages - These pages store the actual key/value data.

  • Overflow pages - These are special pages used when a key's data is too large for a leaf page and needs to spill onto additional pages.