honu

package module

v0.1.0 Latest Latest Go to latest Published: Aug 2, 2021 License: BSD-3-Clause Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rotationalio/honu

Links

Open Source Insights

README ¶

Honu

A library for embedded database replication

Benchmarks

Baseline comparison of honu database vs. pure leveldb performance to determine the overhead that honu adds:

BenchmarkHonuGet-8         	  466665	      2405 ns/op
BenchmarkLevelDBGet-8      	 1243785	       955.3 ns/op
BenchmarkHonuPut-8         	   21448	     55125 ns/op
BenchmarkLevelDBPut-8      	   24276	     52422 ns/op
BenchmarkHonuDelete-8      	   42298	     25136 ns/op
BenchmarkLevelDBDelete-8   	   76857	     16101 ns/op
BenchmarkHonuIter-8        	   63772	     18349 ns/op
BenchmarkLevelDBIter-8     	  255319	      4271 ns/op
BenchmarkHonuObject-8      	  480555	      2362 ns/op

Documentation ¶

Overview ¶

Package honu provides a thin wrapper over an embedded database (leveldb, sqlite) that provides version history to object changes and anti-entropy replication.

Index ¶

type DB
- func Open(uri string, conf config.ReplicaConfig) (db *DB, err error)
type DSN
- func ParseDSN(uri string) (_ *DSN, err error)
type VersionManager
- func NewVersionManager(conf config.ReplicaConfig) (v *VersionManager, err error)
- func (v VersionManager) Delete(meta *pb.Object) error
- func (v VersionManager) Update(meta *pb.Object) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DB ¶

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

DB is a Honu embedded database. Currently DB simply wraps a leveldb database

func Open ¶

func Open(uri string, conf config.ReplicaConfig) (db *DB, err error)

Open a replicated embedded database with the specified URI. Database URIs should specify protocol:///relative/path/to/db for embedded databases. For absolute paths, specify protocol:////absolute/path/to/db.

func (*DB) Close ¶

func (d *DB) Close() error

Close the database, allowing no further interactions.

func (*DB) Delete ¶

func (d *DB) Delete(key []byte) (err error)

Delete the object represented by the key, creating a tombstone object. TODO: provide write options to the underlying database.

func (*DB) Get ¶

func (d *DB) Get(key []byte) (value []byte, err error)

Get the latest version of the object stored by the key. TODO: provide read options to the underlying database.

func (*DB) Iter ¶

func (d *DB) Iter(prefix []byte) (i iterator.Iterator, err error)

Iter over a subset of keys specified by the prefix. TODO: provide better mechanisms for iteration.

func (*DB) Object ¶

func (d *DB) Object(key []byte) (_ *pb.Object, err error)

Object returns metadata associated with the latest object stored by the key.

func (*DB) Put ¶

func (d *DB) Put(key, value []byte) (err error)

Put a new value to the specified key and update the version. TODO: provide write options to the underlying database.

type DSN ¶

type DSN struct {
	Scheme string
	Path   string
}

DSN represents the parsed components of an embedded database service.

func ParseDSN ¶

func ParseDSN(uri string) (_ *DSN, err error)

ParseDSN converts a database URI or URL string into a structured DSN representation.

type VersionManager ¶

type VersionManager struct {
	PID    uint64
	Owner  string
	Region string
}

VersionManager is configured with information associated with the local Replica in order to correctly implement Lamport clocks for sequential, conflict-free replicated versions.

func NewVersionManager ¶

func NewVersionManager(conf config.ReplicaConfig) (v *VersionManager, err error)

NewVersionManager creates a new manager for handling lamport scalar versions.

func (VersionManager) Delete ¶

func (v VersionManager) Delete(meta *pb.Object) error

Delete creates a tombstone version of the object in place.

func (VersionManager) Update ¶

func (v VersionManager) Update(meta *pb.Object) error

Update the version of an object in place. If the object was previously a tombstone (e.g. deleted) then it is "undeleted".

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
config
iterator Package iterator provides an interface and implementations to traverse over the contents of an embedded database while maintaining and reading replicated object metadata.	Package iterator provides an interface and implementations to traverse over the contents of an embedded database while maintaining and reading replicated object metadata.
proto
v1

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL