leaf

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

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

type ItemHandler func(k, v []byte) error

type KeyValueDatabase interface {

	// GetOrCreatKeyspace returns a new keyspace instance from the database, creating it if it doesn't exist
	GetOrCreateKeyspace(string) (Keyspace, error)

	// DeleteKeyspace removes a keyspace from the database
	DeleteKeyspace(string) error

	// Close closes the database connection
	Close() error
}

type Keyspace interface {

	// GetName returns the name of the keyspace
	GetName() string

	// List finds all the keys listed and calls the function provided with the key value pairs
	List([]string, func(k, v []byte)) error

	// Insert adds a key value to the keyspace
	Insert(string, []byte) error

	// Get returns a value with the associated key and returns an error if the key does not exist
	Get(string) ([]byte, error)

	// Update overrides the existing value associated with the given key
	Update(string, []byte) error

	// Delete removes a key from the keyspace
	Delete(string) error

	// Size returns the number of items in the keyspace
	Size() int64

	// ForEach iterates over all the keys in the keyspace
	ForEach(ItemHandler) error

	// Contains determines if the given key exists in the keyspace
	Contains(string) (bool, error)

	// ReadTx allows for more complicated read operations on a particular key, such as reading nested values.
	ReadTx(func(*bolt.Bucket)) error

	// WriteTx allows for more complicated write operations on a particular key, such as writing nested values.
	WriteTx(func(*bolt.Bucket)) error
}