garage/src/db/Cargo.toml

[package]
name = "garage_db"
version = "0.8.0"
authors = ["Alex Auvolat <alex@adnab.me>"]
edition = "2018"
license = "AGPL-3.0"
description = "Abstraction over multiple key/value storage engines that supports transactions"
repository = "https://git.deuxfleurs.fr/Deuxfleurs/garage"
readme = "../../README.md"

[lib]
path = "lib.rs"

[[bin]]
name = "convert"
path = "bin/convert.rs"
required-features = ["cli"]

[dependencies]
err-derive = "0.3"
hexdump = "0.1"
log = "0.4"

heed = "0.11"
rusqlite = { version = "0.27", features = ["bundled"] }
sled = "0.34"

# cli deps
clap = { version = "3.1.18", optional = true, features = ["derive", "env"] }
pretty_env_logger = { version = "0.4", optional = true }

[dev-dependencies]
mktemp = "0.4"

[features]
cli = ["clap", "pretty_env_logger"]
Abstract database behind generic interface and implement alternative drivers (#322) - [x] Design interface - [x] Implement Sled backend - [x] Re-implement the SledCountedTree hack ~~on Sled backend~~ on all backends (i.e. over the abstraction) - [x] Convert Garage code to use generic interface - [x] Proof-read converted Garage code - [ ] Test everything well - [x] Implement sqlite backend - [x] Implement LMDB backend - [ ] (Implement Persy backend?) - [ ] (Implement other backends? (like RocksDB, ...)) - [x] Implement backend choice in config file and garage server module - [x] Add CLI for converting between DB formats - Exploit the new interface to put more things in transactions - [x] `.updated()` trigger on Garage tables Fix #284 Bugs - [x] When exporting sqlite, trees iterate empty?? - [x] LMDB doesn't work Known issues for various back-ends - Sled: - Eats all my RAM and also all my disk space - `.len()` has to traverse the whole table - Is actually quite slow on some operations - And is actually pretty bad code... - Sqlite: - Requires a lock to be taken on all operations. The lock is also taken when iterating on a table with `.iter()`, and the lock isn't released until the iterator is dropped. This means that we must be VERY carefull to not do anything else inside a `.iter()` loop or else we will have a deadlock! Most such cases have been eliminated from the Garage codebase, but there might still be some that remain. If your Garage-over-Sqlite seems to hang/freeze, this is the reason. - (adapter uses a bunch of unsafe code) - Heed (LMDB): - Not suited for 32-bit machines as it has to map the whole DB in memory. - (adpater uses a tiny bit of unsafe code) My recommendation: avoid 32-bit machines and use LMDB as much as possible. Converting databases is actually quite easy. For example from Sled to LMDB: ```bash cd src/db cargo run --features cli --bin convert -- -i path/to/garage/meta/db -a sled -o path/to/garage/meta/db.lmdb -b lmdb ``` Then, just add this to your `config.toml`: ```toml db_engine = "lmdb" ``` Co-authored-by: Alex Auvolat <alex@adnab.me> Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/322 Co-authored-by: Alex <alex@adnab.me> Co-committed-by: Alex <alex@adnab.me> 2022-06-08 08:01:44 +00:00			`[package]`
			`name = "garage_db"`
			`version = "0.8.0"`
			`authors = ["Alex Auvolat <alex@adnab.me>"]`
			`edition = "2018"`
			`license = "AGPL-3.0"`
			`description = "Abstraction over multiple key/value storage engines that supports transactions"`
			`repository = "https://git.deuxfleurs.fr/Deuxfleurs/garage"`
			`readme = "../../README.md"`

			`[lib]`
			`path = "lib.rs"`

			`[[bin]]`
			`name = "convert"`
			`path = "bin/convert.rs"`
			`required-features = ["cli"]`

			`[dependencies]`
			`err-derive = "0.3"`
			`hexdump = "0.1"`
			`log = "0.4"`

			`heed = "0.11"`
			`rusqlite = { version = "0.27", features = ["bundled"] }`
			`sled = "0.34"`

			`# cli deps`
			`clap = { version = "3.1.18", optional = true, features = ["derive", "env"] }`
			`pretty_env_logger = { version = "0.4", optional = true }`

			`[dev-dependencies]`
			`mktemp = "0.4"`

			`[features]`
			`cli = ["clap", "pretty_env_logger"]`