Documentation
¶
Overview ¶
Package database is a generated GoMock package.
Index ¶
- Constants
- Variables
- func BenchmarkBatchDelete(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkBatchPut(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkBatchWrite(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkDelete(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkGet(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkParallelDelete(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkParallelGet(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkParallelPut(b *testing.B, db Database, name string, keys, values [][]byte)
- func BenchmarkPut(b *testing.B, db Database, name string, keys, values [][]byte)
- func Clear(readerDB Iteratee, deleterDB KeyValueDeleter) error
- func ClearPrefix(readerDB Iteratee, deleterDB KeyValueDeleter, prefix []byte) error
- func Count(db Iteratee) (int, error)
- func FuzzKeyValue(f *testing.F, db Database)
- func GetBool(db KeyValueReader, key []byte) (bool, error)
- func GetID(db KeyValueReader, key []byte) (ids.ID, error)
- func GetTimestamp(db KeyValueReader, key []byte) (time.Time, error)
- func GetUInt32(db KeyValueReader, key []byte) (uint32, error)
- func GetUInt64(db KeyValueReader, key []byte) (uint64, error)
- func IsEmpty(db Iteratee) (bool, error)
- func PackUInt32(val uint32) []byte
- func PackUInt64(val uint64) []byte
- func ParseID(b []byte) (ids.ID, error)
- func ParseTimestamp(b []byte) (time.Time, error)
- func ParseUInt32(b []byte) (uint32, error)
- func ParseUInt64(b []byte) (uint64, error)
- func PutBool(db KeyValueWriter, key []byte, b bool) error
- func PutID(db KeyValueWriter, key []byte, val ids.ID) error
- func PutTimestamp(db KeyValueWriter, key []byte, val time.Time) error
- func PutUInt32(db KeyValueWriter, key []byte, val uint32) error
- func PutUInt64(db KeyValueWriter, key []byte, val uint64) error
- func SetupBenchmark(b *testing.B, count int, keySize, valueSize int) ([][]byte, [][]byte)
- func Size(db Iteratee) (int, error)
- func TestBatchDelete(t *testing.T, db Database)
- func TestBatchInner(t *testing.T, db Database)
- func TestBatchLargeSize(t *testing.T, db Database)
- func TestBatchPut(t *testing.T, db Database)
- func TestBatchReplay(t *testing.T, db Database)
- func TestBatchReset(t *testing.T, db Database)
- func TestBatchReuse(t *testing.T, db Database)
- func TestBatchRewrite(t *testing.T, db Database)
- func TestClear(t *testing.T, db Database)
- func TestClearPrefix(t *testing.T, db Database)
- func TestCompactNoPanic(t *testing.T, db Database)
- func TestConcurrentBatches(t *testing.T, db Database)
- func TestIterator(t *testing.T, db Database)
- func TestIteratorClosed(t *testing.T, db Database)
- func TestIteratorError(t *testing.T, db Database)
- func TestIteratorErrorAfterRelease(t *testing.T, db Database)
- func TestIteratorMemorySafety(t *testing.T, db Database)
- func TestIteratorPrefix(t *testing.T, db Database)
- func TestIteratorSnapshot(t *testing.T, db Database)
- func TestIteratorStart(t *testing.T, db Database)
- func TestIteratorStartPrefix(t *testing.T, db Database)
- func TestKeyEmptyValue(t *testing.T, db Database)
- func TestManySmallConcurrentKVPairBatches(t *testing.T, db Database)
- func TestMemorySafetyBatch(t *testing.T, db Database)
- func TestMemorySafetyDatabase(t *testing.T, db Database)
- func TestModifyValueAfterBatchPut(t *testing.T, db Database)
- func TestModifyValueAfterBatchPutReplay(t *testing.T, db Database)
- func TestModifyValueAfterPut(t *testing.T, db Database)
- func TestNewBatchClosed(t *testing.T, db Database)
- func TestPutGetEmpty(t *testing.T, db Database)
- func TestSimpleKeyValue(t *testing.T, db Database)
- func TestSimpleKeyValueClosed(t *testing.T, db Database)
- type Batch
- type Batcher
- type Compacter
- type Database
- type Iteratee
- type Iterator
- type KeyValueDeleter
- type KeyValueReader
- type KeyValueReaderWriter
- type KeyValueReaderWriterDeleter
- type KeyValueWriter
- type KeyValueWriterDeleter
- type MockBatch
- func (m *MockBatch) Delete(arg0 []byte) error
- func (m *MockBatch) EXPECT() *MockBatchMockRecorder
- func (m *MockBatch) Inner() Batch
- func (m *MockBatch) Put(arg0, arg1 []byte) error
- func (m *MockBatch) Replay(arg0 KeyValueWriterDeleter) error
- func (m *MockBatch) Reset()
- func (m *MockBatch) Size() int
- func (m *MockBatch) Write() error
- type MockBatchMockRecorder
- func (mr *MockBatchMockRecorder) Delete(arg0 interface{}) *gomock.Call
- func (mr *MockBatchMockRecorder) Inner() *gomock.Call
- func (mr *MockBatchMockRecorder) Put(arg0, arg1 interface{}) *gomock.Call
- func (mr *MockBatchMockRecorder) Replay(arg0 interface{}) *gomock.Call
- func (mr *MockBatchMockRecorder) Reset() *gomock.Call
- func (mr *MockBatchMockRecorder) Size() *gomock.Call
- func (mr *MockBatchMockRecorder) Write() *gomock.Call
Constants ¶
const ( // If, when a batch is reset, the cap(batch)/len(batch) > MaxExcessCapacityFactor, // the underlying array's capacity will be reduced by a factor of capacityReductionFactor. // Higher value for MaxExcessCapacityFactor --> less aggressive array downsizing --> less memory allocations // but more unnecessary data in the underlying array that can't be garbage collected. // Higher value for CapacityReductionFactor --> more aggressive array downsizing --> more memory allocations // but less unnecessary data in the underlying array that can't be garbage collected. MaxExcessCapacityFactor = 4 CapacityReductionFactor = 2 )
const (
Uint64Size = 8 // bytes
)
Variables ¶
var ( // Benchmarks is a list of all database benchmarks Benchmarks = []func(b *testing.B, db Database, name string, keys, values [][]byte){ BenchmarkGet, BenchmarkPut, BenchmarkDelete, BenchmarkBatchPut, BenchmarkBatchDelete, BenchmarkBatchWrite, BenchmarkParallelGet, BenchmarkParallelPut, BenchmarkParallelDelete, } // BenchmarkSizes to use with each benchmark BenchmarkSizes = [][]int{ {1024, 32, 32}, {1024, 256, 256}, {1024, 2 * units.KiB, 2 * units.KiB}, } )
var ( ErrClosed = errors.New("closed") ErrNotFound = errors.New("not found") )
common errors
var FuzzTests = []func(*testing.F, Database){ FuzzKeyValue, }
var Tests = []func(t *testing.T, db Database){ TestSimpleKeyValue, TestKeyEmptyValue, TestSimpleKeyValueClosed, TestNewBatchClosed, TestBatchPut, TestBatchDelete, TestBatchReset, TestBatchReuse, TestBatchRewrite, TestBatchReplay, TestBatchInner, TestBatchLargeSize, TestIteratorSnapshot, TestIterator, TestIteratorStart, TestIteratorPrefix, TestIteratorStartPrefix, TestIteratorMemorySafety, TestIteratorClosed, TestIteratorError, TestIteratorErrorAfterRelease, TestCompactNoPanic, TestMemorySafetyDatabase, TestMemorySafetyBatch, TestClear, TestClearPrefix, TestModifyValueAfterPut, TestModifyValueAfterBatchPut, TestModifyValueAfterBatchPutReplay, TestConcurrentBatches, TestManySmallConcurrentKVPairBatches, TestPutGetEmpty, }
Tests is a list of all database tests
Functions ¶
func BenchmarkBatchDelete ¶
BenchmarkBatchDelete measures the time it takes to batch delete.
func BenchmarkBatchPut ¶
BenchmarkBatchPut measures the time it takes to batch put.
func BenchmarkBatchWrite ¶
BenchmarkBatchWrite measures the time it takes to batch write.
func BenchmarkDelete ¶
BenchmarkDelete measures the time it takes to delete a (k, v) from a database.
func BenchmarkGet ¶
BenchmarkGet measures the time it takes to get an operation from a database.
func BenchmarkParallelDelete ¶
BenchmarkParallelDelete measures the time it takes to delete a (k, v) from the db.
func BenchmarkParallelGet ¶
BenchmarkParallelGet measures the time it takes to read in parallel.
func BenchmarkParallelPut ¶
BenchmarkParallelPut measures the time it takes to write to the db in parallel.
func BenchmarkPut ¶
BenchmarkPut measures the time it takes to write an operation to a database.
func Clear ¶
func Clear(readerDB Iteratee, deleterDB KeyValueDeleter) error
func ClearPrefix ¶
func ClearPrefix(readerDB Iteratee, deleterDB KeyValueDeleter, prefix []byte) error
func FuzzKeyValue ¶ added in v1.8.7
func GetTimestamp ¶
func GetTimestamp(db KeyValueReader, key []byte) (time.Time, error)
func PackUInt32 ¶
func PackUInt64 ¶
func ParseUInt32 ¶
func ParseUInt64 ¶
func PutTimestamp ¶
func PutTimestamp(db KeyValueWriter, key []byte, val time.Time) error
func SetupBenchmark ¶
Writes size data into the db in order to setup reads in subsequent tests.
func TestBatchDelete ¶
TestBatchDelete tests to make sure that batched deletes work as expected.
func TestBatchInner ¶
TestBatchInner tests to make sure that inner can be used to write to the database.
func TestBatchLargeSize ¶
TestBatchLargeSize tests to make sure that the batch can support a large amount of entries.
func TestBatchPut ¶
TestBatchPut tests to make sure that batched writes work as expected.
func TestBatchReplay ¶
TestBatchReplay tests to make sure that batches will correctly replay their contents.
func TestBatchReset ¶
TestBatchReset tests to make sure that a batch drops un-written operations when it is reset.
func TestBatchReuse ¶
TestBatchReuse tests to make sure that a batch can be reused once it is reset.
func TestBatchRewrite ¶
TestBatchRewrite tests to make sure that write can be called multiple times on a batch and the values will be updated correctly.
func TestClearPrefix ¶
TestClearPrefix tests to make sure prefix deletion works as expected.
func TestCompactNoPanic ¶
TestCompactNoPanic tests to make sure compact never panics.
func TestConcurrentBatches ¶
func TestIterator ¶
TestIterator tests to make sure the database iterates over the database contents lexicographically.
func TestIteratorClosed ¶
TestIteratorClosed tests to make sure that an iterator that was created with a closed database will report a closed error correctly.
func TestIteratorError ¶
TestIteratorError tests to make sure that an iterator on a database will report itself as being exhausted and return ErrClosed to indicate that the iteration was not successful. Additionally tests that an iterator that has already called Next() can still serve its current value after the underlying DB was closed.
func TestIteratorErrorAfterRelease ¶
TestIteratorErrorAfterRelease tests to make sure that an iterator that was released still reports the error correctly.
func TestIteratorMemorySafety ¶
TestIteratorMemorySafety tests to make sure that keys can values are able to be modified from the returned iterator.
func TestIteratorPrefix ¶
TestIteratorPrefix tests to make sure the iterator can be configured to skip keys missing the provided prefix.
func TestIteratorSnapshot ¶
TestIteratorSnapshot tests to make sure the database iterates over a snapshot of the database at the time of the iterator creation.
func TestIteratorStart ¶
TestIteratorStart tests to make sure the the iterator can be configured to start mid way through the database.
func TestIteratorStartPrefix ¶
TestIteratorStartPrefix tests to make sure that the iterator can start mid way through the database while skipping a prefix.
func TestKeyEmptyValue ¶
func TestMemorySafetyBatch ¶
TestMemorySafetyDatabase ensures it is safe to modify a key after passing it to Batch.Put.
func TestMemorySafetyDatabase ¶
TestMemorySafetyDatabase ensures it is safe to modify a key after passing it to Database.Put and Database.Get.
func TestModifyValueAfterPut ¶
func TestNewBatchClosed ¶ added in v1.8.7
TestNewBatchClosed tests to make sure that calling NewBatch on a closed database returns a batch that errors correctly.
func TestPutGetEmpty ¶ added in v1.8.7
func TestSimpleKeyValue ¶
TestSimpleKeyValue tests to make sure that simple Put + Get + Delete + Has calls return the expected values.
func TestSimpleKeyValueClosed ¶
TestSimpleKeyValueClosed tests to make sure that Put + Get + Delete + Has calls return the correct error when the database has been closed.
Types ¶
type Batch ¶
type Batch interface {
KeyValueWriterDeleter
// Size retrieves the amount of data queued up for writing, this includes
// the keys, values, and deleted keys.
Size() int
// Write flushes any accumulated data to disk.
Write() error
// Reset resets the batch for reuse.
Reset()
// Replay replays the batch contents in the same order they were written
// to the batch.
Replay(w KeyValueWriterDeleter) error
// Inner returns a Batch writing to the inner database, if one exists. If
// this batch is already writing to the base DB, then itself should be
// returned.
Inner() Batch
}
Batch is a write-only database that commits changes to its host database when Write is called. A batch cannot be used concurrently.
type Batcher ¶
type Batcher interface {
// NewBatch creates a write-only database that buffers changes to its host db
// until a final write is called.
NewBatch() Batch
}
Batcher wraps the NewBatch method of a backing data store.
type Compacter ¶
type Compacter interface {
// Compact the underlying DB for the given key range.
// Specifically, deleted and overwritten versions are discarded,
// and the data is rearranged to reduce the cost of operations
// needed to access the data. This operation should typically only
// be invoked by users who understand the underlying implementation.
//
// A nil start is treated as a key before all keys in the DB.
// And a nil limit is treated as a key after all keys in the DB.
// Therefore if both are nil then it will compact entire DB.
//
// Note: [start] and [limit] are safe to modify and read after calling Compact.
Compact(start []byte, limit []byte) error
}
Compacter wraps the Compact method of a backing data store.
type Database ¶
type Database interface {
KeyValueReaderWriterDeleter
Batcher
Iteratee
Compacter
io.Closer
health.Checker
}
Database contains all the methods required to allow handling different key-value data stores backing the database.
type Iteratee ¶
type Iteratee interface {
// NewIterator creates an iterator over the entire keyspace contained within
// the key-value database.
NewIterator() Iterator
// NewIteratorWithStart creates an iterator over a subset of database
// content starting at a particular initial key.
NewIteratorWithStart(start []byte) Iterator
// NewIteratorWithPrefix creates an iterator over a subset of database
// content with a particular key prefix.
NewIteratorWithPrefix(prefix []byte) Iterator
// NewIteratorWithStartAndPrefix creates an iterator over a subset of
// database content with a particular key prefix starting at a specified
// key.
NewIteratorWithStartAndPrefix(start, prefix []byte) Iterator
}
Iteratee wraps the NewIterator methods of a backing data store.
type Iterator ¶
type Iterator interface {
// Next moves the iterator to the next key/value pair. It returns whether
// the iterator successfully moved to a new key/value pair.
// The iterator may return false if the underlying database has been closed
// before the iteration has completed, in which case future calls to Error()
// must return [ErrClosed].
Next() bool
// Error returns any accumulated error. Exhausting all the key/value pairs
// is not considered to be an error.
// Error should be called after all key/value pairs have been exhausted ie.
// after Next() has returned false.
Error() error
// Key returns the key of the current key/value pair, or nil if done.
Key() []byte
// Value returns the value of the current key/value pair, or nil if done.
Value() []byte
// Release releases associated resources. Release should always succeed and
// can be called multiple times without causing error.
Release()
}
Iterator iterates over a database's key/value pairs.
When it encounters an error any seek will return false and will yield no key/ value pairs. The error can be queried by calling the Error method. Calling Release is still necessary.
An iterator must be released after use, but it is not necessary to read an iterator until exhaustion. An iterator is not safe for concurrent use, but it is safe to use multiple iterators concurrently.
type KeyValueDeleter ¶
type KeyValueDeleter interface {
// Delete removes the key from the key-value data store.
//
// Note: [key] is safe to modify and read after calling Delete.
Delete(key []byte) error
}
KeyValueDeleter wraps the Delete method of a backing data store.
type KeyValueReader ¶
type KeyValueReader interface {
// Has retrieves if a key is present in the key-value data store.
//
// Note: [key] is safe to modify and read after calling Has.
Has(key []byte) (bool, error)
// Get retrieves the given key if it's present in the key-value data store.
//
// Note: [key] is safe to modify and read after calling Get.
// The returned byte slice is safe to read, but cannot be modified.
Get(key []byte) ([]byte, error)
}
KeyValueReader wraps the Has and Get method of a backing data store.
type KeyValueReaderWriter ¶
type KeyValueReaderWriter interface {
KeyValueReader
KeyValueWriter
}
KeyValueReaderWriter allows read/write acccess to a backing data store.
type KeyValueReaderWriterDeleter ¶
type KeyValueReaderWriterDeleter interface {
KeyValueReader
KeyValueWriter
KeyValueDeleter
}
KeyValueReaderWriterDeleter allows read/write/delete access to a backing data store.
type KeyValueWriter ¶
type KeyValueWriter interface {
// Put inserts the given value into the key-value data store.
//
// Note: [key] and [value] are safe to modify and read after calling Put.
//
// If [value] is nil or an empty slice, then when it's retrieved
// it may be nil or an empty slice.
Put(key []byte, value []byte) error
}
KeyValueWriter wraps the Put method of a backing data store.
type KeyValueWriterDeleter ¶
type KeyValueWriterDeleter interface {
KeyValueWriter
KeyValueDeleter
}
KeyValueWriterDeleter allows write/delete acccess to a backing data store.
type MockBatch ¶
type MockBatch struct {
// contains filtered or unexported fields
}
MockBatch is a mock of Batch interface.
func NewMockBatch ¶
func NewMockBatch(ctrl *gomock.Controller) *MockBatch
NewMockBatch creates a new mock instance.
func (*MockBatch) EXPECT ¶
func (m *MockBatch) EXPECT() *MockBatchMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockBatch) Replay ¶
func (m *MockBatch) Replay(arg0 KeyValueWriterDeleter) error
Replay mocks base method.
type MockBatchMockRecorder ¶
type MockBatchMockRecorder struct {
// contains filtered or unexported fields
}
MockBatchMockRecorder is the mock recorder for MockBatch.
func (*MockBatchMockRecorder) Delete ¶
func (mr *MockBatchMockRecorder) Delete(arg0 interface{}) *gomock.Call
Delete indicates an expected call of Delete.
func (*MockBatchMockRecorder) Inner ¶
func (mr *MockBatchMockRecorder) Inner() *gomock.Call
Inner indicates an expected call of Inner.
func (*MockBatchMockRecorder) Put ¶
func (mr *MockBatchMockRecorder) Put(arg0, arg1 interface{}) *gomock.Call
Put indicates an expected call of Put.
func (*MockBatchMockRecorder) Replay ¶
func (mr *MockBatchMockRecorder) Replay(arg0 interface{}) *gomock.Call
Replay indicates an expected call of Replay.
func (*MockBatchMockRecorder) Reset ¶
func (mr *MockBatchMockRecorder) Reset() *gomock.Call
Reset indicates an expected call of Reset.
func (*MockBatchMockRecorder) Size ¶
func (mr *MockBatchMockRecorder) Size() *gomock.Call
Size indicates an expected call of Size.
func (*MockBatchMockRecorder) Write ¶
func (mr *MockBatchMockRecorder) Write() *gomock.Call
Write indicates an expected call of Write.
Source Files
Directories