Expand description
§redb
A simple, portable, high-performance, ACID, embedded key-value store.
redb is written in pure Rust and is loosely inspired by lmdb. Data is stored in a collection of copy-on-write B+trees. For more details, see the design doc.
§Features
- Zero-copy, thread-safe,
BTreeMapbased API - Fully ACID-compliant transactions
- MVCC support for concurrent readers & writer, without blocking
- Crash-safe by default
- Savepoints and rollbacks
§Example
use redb::{Database, Error, ReadableDatabase, ReadableTable, TableDefinition};
const TABLE: TableDefinition<&str, u64> = TableDefinition::new("my_data");
fn main() -> Result<(), Error> {
let file = tempfile::NamedTempFile::new().unwrap();
let db = Database::create(file.path())?;
let write_txn = db.begin_write()?;
{
let mut table = write_txn.open_table(TABLE)?;
table.insert("my_key", &123)?;
}
write_txn.commit()?;
let read_txn = db.begin_read()?;
let table = read_txn.open_table(TABLE)?;
assert_eq!(table.get_owned("my_key")?.unwrap().value(), 123);
Ok(())
}§Crate features
std: enabled by default. Withexperimental-api-5on, disable it to build redb as ano_stdcrate; see the README for what that mode requires and leaves out.
Modules§
Structs§
- Access
Guard - Scoped accessor to data in the database
- Access
Guard Mut - Access
Guard MutIn Place - Builder
- Configuration builder of a redb Database.
- Cache
Stats - Information regarding the usage of the in-memory cache
- Database
- Opened redb database file
- Database
Stats - Informational storage stats about the database
- Extract
If - Multimap
Range - Multimap
Table - A multimap table
- Multimap
Table Definition - Defines the name and types of a multimap table
- Multimap
Value - Occupied
Entry - A view into an occupied entry in a
Table. It is part of theEntryenum. - Owned
Access Guard - An
AccessGuardwhich also keeps the transaction alive - Owned
Multimap Range - A
MultimapRangewhich also keeps the transaction alive - Owned
Multimap Value - A
MultimapValuewhich also keeps the transaction alive - Owned
Range - A
Rangewhich also keeps the transaction alive - Range
- Read
Only Database - A redb database opened in read-only mode
- Read
Only Multimap Table - A read-only multimap table
- Read
Only Table - A read-only table
- Read
Only Untyped Multimap Table - A read-only untyped multimap table
- Read
Only Untyped Table - A read-only untyped table
- Read
Transaction - A read-only transaction
- Repair
Session - Savepoint
- A database savepoint
- Table
- A table containing key-value mappings
- Table
Definition - Defines the name and types of a table
- Table
Stats - Informational storage stats about a table
- Type
Name - Untyped
Multimap Table Handle - Untyped
Table Handle - Vacant
Entry - A view into a vacant entry in a
Table. It is part of theEntryenum. - Write
Transaction - A read/write transaction
Enums§
- Commit
Error - Errors related to committing transactions
- Compaction
Error - Errors related to compaction
- Database
Error - Errors related to opening a database
- Durability
- Entry
- A view into a single entry in a
Table, which may either be vacant or occupied. - Error
- Superset of all other errors that can occur. Convenience enum so that users can convert all errors into a single type
- Savepoint
Error - Errors related to savepoints
- SetDurability
Error - Errors related to transactions
- Storage
Error - General errors directly from the storage layer
- Table
Error - Errors related to opening tables
- Transaction
Error - Errors related to transactions
Traits§
- Key
- Trait which allows the type to be used as a key in a redb table
- Multimap
Table Handle - MutIn
Place Value - Implementing this trait indicates that the type can be mutated in-place as a &mut u8.
This enables the
.insert_reserve()method on Table - Readable
Database - Readable
Multimap Table - Readable
Table - Readable
Table Metadata - Storage
Backend - Implements persistent storage for a database.
- Table
Handle - Value
- Types that implement this trait can be used as values in a redb table
