kv

type ComparisonType proto.KeyComparisonType

type DB interface {
	io.Closer

	EnableNotifications(enable bool)

	ProcessWrite(b *proto.WriteRequest, commitOffset int64, timestamp uint64, updateOperationCallback UpdateOperationCallback) (*proto.WriteResponse, error)
	Get(request *proto.GetRequest) (*proto.GetResponse, error)
	List(request *proto.ListRequest) (KeyIterator, error)
	RangeScan(request *proto.RangeScanRequest) (RangeScanIterator, error)
	ReadCommitOffset() (int64, error)

	ReadNextNotifications(ctx context.Context, startOffset int64) ([]*proto.NotificationBatch, error)

	UpdateTerm(newTerm int64, options TermOptions) error
	ReadTerm() (term int64, options TermOptions, err error)

	Snapshot() (Snapshot, error)

	// Delete and close the database and all its files
	Delete() error
}

type Factory interface {
	io.Closer

	NewKV(namespace string, shardId int64) (KV, error)

	NewSnapshotLoader(namespace string, shardId int64) (SnapshotLoader, error)
}

type FactoryOptions struct {
	DataDir     string
	CacheSizeMB int64

	// Create a pure in-memory database. Used for unit-tests
	InMemory bool
}

type KV interface {
	io.Closer

	NewWriteBatch() WriteBatch

	Get(key string, comparisonType ComparisonType) (storedKey string, value []byte, closer io.Closer, err error)

	KeyRangeScan(lowerBound, upperBound string) (KeyIterator, error)
	KeyRangeScanReverse(lowerBound, upperBound string) (ReverseKeyIterator, error)

	RangeScan(lowerBound, upperBound string) (KeyValueIterator, error)

	Snapshot() (Snapshot, error)

	Flush() error

	Delete() error
}

type KeyIterator interface {
	io.Closer

	Valid() bool
	Key() string
	Next() bool
}

type KeyValueIterator interface {
	KeyIterator

	Value() ([]byte, error)
}

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

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

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

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

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

type RangeScanIterator interface {
	io.Closer

	Valid() bool
	Value() (*proto.GetResponse, error)
	Next() bool
}

type ReverseKeyIterator interface {
	io.Closer

	Valid() bool
	Key() string
	Prev() bool
}

type Snapshot interface {
	io.Closer

	BasePath() string

	Valid() bool
	Chunk() (SnapshotChunk, error)
	Next() bool
}

type SnapshotChunk interface {
	Name() string
	Index() int32
	TotalCount() int32
	Content() []byte
}

type SnapshotLoader interface {
	io.Closer

	AddChunk(fileName string, chunkIndex int32, chunkCount int32, content []byte) error

	// Complete signals that the snapshot is now complete
	Complete()
}

type TermOptions struct {
	NotificationsEnabled bool
}

type UpdateOperationCallback interface {
	OnPut(batch WriteBatch, req *proto.PutRequest, se *proto.StorageEntry) (proto.Status, error)
	OnDelete(batch WriteBatch, key string) error
	OnDeleteRange(batch WriteBatch, keyStartInclusive string, keyEndExclusive string) error
}

type WriteBatch interface {
	io.Closer

	Put(key string, value []byte) error
	Delete(key string) error
	Get(key string) ([]byte, io.Closer, error)
	FindLower(key string) (lowerKey string, err error)

	DeleteRange(lowerBound, upperBound string) error
	KeyRangeScan(lowerBound, upperBound string) (KeyIterator, error)
	RangeScan(lowerBound, upperBound string) (KeyValueIterator, error)

	// Count is the number of transactions that are currently in the batch
	Count() int

	// Size of all the transactions that are currently in the batch
	Size() int

	Commit() error
}