database

Documentation

Index

• Constants
• type Batch
• type Database
• type Deleter
• type Dereferencer
• type Putter
• type Referencer

Constants

const IdealBatchSize = 100 * 1024

Code using batches should try to add this much data to the batch. The value was determined empirically.

Types

type Batch

type Batch interface {
	Putter
	Deleter
	Referencer
	Dereferencer
	ValueSize() int // amount of data in the batch
	Write() error
	// Reset resets the batch for reuse
	Reset()
}

Batch is a write-only database that commits changes to its host database when Write is called. Batch cannot be used concurrently.

type Database

type Database interface {
	Putter
	Deleter
	Referencer
	Dereferencer
	Get(key []byte) ([]byte, error)
	Has(key []byte) (bool, error)
	CountReference(key []byte) (int, error)
	Close()
	NewBatch() Batch
}

Database wraps all database operations. All methods are safe for concurrent use.

type Deleter

type Deleter interface {
	Delete(key []byte) error
}

Deleter wraps the database delete operation supported by both batches and regular databases.

type Dereferencer

type Dereferencer interface {
	Dereference(key []byte) error
}

Dereferencer wraps the database dereference operation supported by both batches and regular databases.

type Putter

type Putter interface {
	Put(key []byte, value []byte) error
}

Putter wraps the database write operation supported by both batches and regular databases.

type Referencer

type Referencer interface {
	Reference(key []byte) error
}

Referencer wraps the database reference operation supported by both batches and regular databases.