Documentation
¶
Index ¶
- Constants
- Variables
- func CompressionAlgoStrings() []string
- func NewBloomFilterStub(params BloomFilterParams) bloomFilterStub
- func NewStore(path string) *storeImpl
- func SafeKey(k KeyInter) []byte
- func SafeValue(k ValueInter) []byte
- type Batch
- type BloomFilter
- type BloomFilterParams
- type CacheParams
- type CompressionAlgo
- type IterableKeyVal
- type Iterator
- type KeyInter
- type KeyVal
- func (k *KeyVal) Close() error
- func (k *KeyVal) Delete(key []byte) error
- func (k *KeyVal) Flush(b1 Batch) error
- func (k *KeyVal) Get(key []byte) ([]byte, error)
- func (k *KeyVal) Has(key []byte) (bool, error)
- func (k *KeyVal) NewBatch() (Batch, error)
- func (k *KeyVal) NewKeyIterator(prefix []byte) (Iterator, error)
- func (k *KeyVal) Put(key, val []byte) error
- type KeyValParams
- type KeyValue
- type NoOpStore
- type ValueInter
Constants ¶
View Source
const ( CompressionDefault = CompressionAlgo(opt.DefaultCompression) // = Snappy CompressionNone = CompressionAlgo(opt.NoCompression) CompressionSnappy = CompressionAlgo(opt.SnappyCompression) CompressionZSTD = CompressionAlgo(opt.ZSTDCompression) CompressionMinLZ = CompressionAlgo(opt.MinLZCompression) )
Variables ¶
View Source
var ErrNotFound = errors.New("not found")
Functions ¶
func CompressionAlgoStrings ¶ added in v0.11.0
func CompressionAlgoStrings() []string
CompressionAlgoStrings returns a slice of all String values of the enum
func NewBloomFilterStub ¶ added in v0.8.8
func NewBloomFilterStub(params BloomFilterParams) bloomFilterStub
func SafeValue ¶ added in v0.3.0
func SafeValue(k ValueInter) []byte
Types ¶
type BloomFilter ¶ added in v0.8.8
type BloomFilter interface {
Params() BloomFilterParams
io.WriterTo
// contains filtered or unexported methods
}
type BloomFilterParams ¶ added in v0.3.0
type BloomFilterParams struct {
// BloomFilterCapacity is how many items will be added to the filter.
BloomFilterCapacity uint64
// FalsePositiveProbability is acceptable false positive rate {0..1}.
FalsePositiveProbability float64
// Bloom store.
BloomFilterStore store
// Disable bloom filter.
DisableBloomFilter bool
}
func NewBloomFilterParams ¶ added in v0.3.0
func NewBloomFilterParams(capacity uint64, probability float64, store store) BloomFilterParams
type CacheParams ¶ added in v0.3.0
type CacheParams struct {
CacheSize int
}
type CompressionAlgo ¶ added in v0.11.0
type CompressionAlgo opt.Compression
func CompressionAlgoString ¶ added in v0.11.0
func CompressionAlgoString(s string) (CompressionAlgo, error)
CompressionAlgoString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func CompressionAlgoValues ¶ added in v0.11.0
func CompressionAlgoValues() []CompressionAlgo
CompressionAlgoValues returns all values of the enum
func (CompressionAlgo) IsACompressionAlgo ¶ added in v0.11.0
func (i CompressionAlgo) IsACompressionAlgo() bool
IsACompressionAlgo returns "true" if the value is listed in the enum definition. "false" otherwise
func (CompressionAlgo) MarshalText ¶ added in v0.11.0
func (i CompressionAlgo) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for CompressionAlgo
func (CompressionAlgo) String ¶ added in v0.11.0
func (i CompressionAlgo) String() string
func (*CompressionAlgo) UnmarshalText ¶ added in v0.11.0
func (i *CompressionAlgo) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for CompressionAlgo
type IterableKeyVal ¶
type KeyValParams ¶ added in v0.3.0
type KeyValParams struct {
CacheParams
BloomFilterParams
WriteBuffer int
CompactionTableSize int
CompactionTotalSize int
OpenFilesCacheCapacity int
CompressionAlgo CompressionAlgo
}
type ValueInter ¶ added in v0.6.0
type ValueInter interface {
Value() []byte
}
Click to show internal directories.
Click to hide internal directories.