Crate boringdb

BoringDB

A SQLite-based, single-process, key-value database.

You want boringdb if:

• You want high performance somewhat approaching that of databases like sled and RocksDB
• You don’t need SQL, multiprocess support, or the other cool features of SQLite
• You want SQLite’s proven reliability

A note on durability

By default, boringdb has eventual durability: database state is guaranteed to be consistent even in the face of arbitrary crashes, and transactions are guaranteed to have “serializable” semantics. However, after a crash the database may be slightly out of date, usually by a fraction of a second.

To avoid this behavior, use the Dict::flush method to manually force synchronization with disk. Note that this comes with a fairly severe performance cost.

Method Of Operation

BoringDB stores key/value pairs into byte vectors (Vec<u8>).

Examples

Examples can be found in the examples directory

Structs

Database

A database full of maps.

Dict

A cloneable on-disk mapping, corresponding to a table in SQLite

Enums

DbError

A database error. Generally, these errors are quite fatal, and in application code unwrapping them is usually fine.

Type Aliases

BoringResult

Result type used throughout the codebase.