storage

type Batch interface {
	// put the value to entry associate with the key
	Put(key, value []byte)

	// delete the entry associate with the key in the Storage
	Del(key []byte)

	// remove all the enqueued put/delete
	Clear()

	// returns the number of updates in the batch
	Count() int

	// atomic writes all enqueued put/delete
	Write() error

	// close the batch, it must be called to close the batch
	Close()
}

type Config struct {
	Name    string  `mapstructure:"name"`
	Path    string  `mapstructure:"path"`
	Options Options `mapstructure:"options"`
}

type Database struct {
	Storage
	// contains filtered or unexported fields
}

type Operations interface {
	Writer
	Reader
}

type Options map[string]interface{}

type Reader interface {
	// return value associate with the key in the Storage
	Get(key []byte) ([]byte, error)

	// return values associate with the keys in the Storage
	MultiGet(key ...[]byte) ([][]byte, error)

	// check if the entry associate with key exists
	Has(key []byte) (bool, error)

	// return a set of keys in the Storage
	Keys() [][]byte

	// return a chan to iter all keys
	IterKeys(ctx context.Context) <-chan []byte

	// return a set of keys with specified prefix in the Storage
	KeysWithPrefix(prefix []byte) [][]byte

	// return a chan to iter all keys with specified prefix
	IterKeysWithPrefix(ctx context.Context, prefix []byte) <-chan []byte
}

type Storage interface {
	Table

	// Create or Get the table associated with the name
	Table(string) (Table, error)
	DropTable(string) error

	Close() error
}

type Table interface {
	Operations

	EnableBatch()
	DisableBatch()
	IsInBatch() bool
	Flush() error

	// NewTransaction creates a new transaction on the Storage.
	NewTransaction() (Transaction, error)
}

type Transaction interface {
	Operations

	// Commit finalizes a transaction, attempting to commit it to the Storage.
	Commit() error

	// Discard throws away changes recorded in a transaction without committing.
	// them to the underlying Storage. Any calls made to Discard after Commit
	// has been successfully called will have no effect on the transaction and
	// state of the Storage, making it safe to defer.
	Discard()
}

type Writer interface {
	// put the value to entry associate with the key
	Put(key, value []byte) error

	// delete the entry associate with the key in the Storage
	Del(key []byte) error
}