rocksdb

package

v0.0.0-...-1aaebbc Latest Latest Go to latest Published: Jun 13, 2021 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type DB interface {
	storage.KVStore
	storage.Backupable
	storage.ChangePropagator
	storage.ChangeApplier
}

DB interface represents the capabilities exposed by the underlying implmentation based on RocksDB engine.

func OpenDB(dbFolder string, dbOpts ...DBOption) (DB, error)

OpenDB initializes a new instance of RocksDB with specified options. It uses the given folder for storing the data files.

type DBOption func(*rocksDBOpts)

DBOption is used to configure the RocksDB storage engine.

func WithCacheSize(size uint64) DBOption

WithCacheSize is used to set the block cache size.

func WithLogger(lgr *zap.Logger) DBOption

WithLogger is used to inject a ZAP logger instance.

func WithRocksDBConfig(iniFile string) DBOption

WithRocksDBConfig can be used to override internal RocksDB storage settings through the given .ini file.

func WithSSTDir(sstDir string) DBOption

WithSSTDir configures the directory to be used for SST Operation on RocksDB.

func WithStats(statsCli stats.Client) DBOption

WithStats is used to inject a metrics client.

func WithSyncWrites() DBOption

WithSyncWrites ensures all writes to RocksDB are immediatey flushed to disk from OS buffers.

type WriteBatchIterator struct {
	// contains filtered or unexported fields
}

WriteBatchIterator represents a iterator to iterator over records.

func NewWriteBatchIterator(wbData []byte) *WriteBatchIterator

NewWriteBatchIterator creates a new write batch iterator initialised with the given write batch data byte array.

func (iter *WriteBatchIterator) Error() error

Error returns the error if the iteration is failed.

func (iter *WriteBatchIterator) Next() bool

Next returns the next record. Returns false if no further record exists.

func (iter *WriteBatchIterator) Record() *gorocksdb.WriteBatchRecord

Record returns the current record.