Skip to content

Commit

Permalink
update *DBBackend descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
melekes committed Sep 20, 2024
1 parent 42ec7cd commit 6ff41ac
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions db.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ type BackendType string
const (
// GoLevelDBBackend represents goleveldb (github.com/syndtr/goleveldb - most
// popular implementation)
// - UNMAINTANED
// - pure go
// - stable
// - unmaintaned
// - use goleveldb build tag (go build -tags goleveldb)
GoLevelDBBackend BackendType = "goleveldb"
// CLevelDBBackend represents cleveldb (uses levigo wrapper)
// - DEPRECATED
// - fast
// - requires gcc
// - use cleveldb build tag (go build -tags cleveldb)
Expand All @@ -25,22 +27,20 @@ const (
MemDBBackend BackendType = "memdb"
// BoltDBBackend represents bolt (uses etcd's fork of bolt -
// github.com/etcd-io/bbolt)
// - EXPERIMENTAL
// - may be faster is some use-cases (random reads - indexer)
// - DEPRECATED
// - pure go
// - use boltdb build tag (go build -tags boltdb)
BoltDBBackend BackendType = "boltdb"
// RocksDBBackend represents rocksdb (uses github.com/tecbot/gorocksdb)
// - EXPERIMENTAL
// - requires gcc
// - use rocksdb build tag (go build -tags rocksdb)
RocksDBBackend BackendType = "rocksdb"
// BadgerDBBackend represents badger (uses github.com/dgraph-io/badger)
// - EXPERIMENTAL
// - pure go
// - use badgerdb build tag (go build -tags badgerdb)
BadgerDBBackend BackendType = "badgerdb"
// PebbleDBDBBackend represents pebble (uses github.com/cockroachdb/pebble)
// - EXPERIMENTAL
// - use pebbledb build tag (go build -tags pebbledb)
// - pure go
PebbleDBBackend BackendType = "pebbledb"
)

Expand Down

0 comments on commit 6ff41ac

Please sign in to comment.