Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

hashdb

package

Go to main page

Versions in this module

v0

v0.3.0

Feb 7, 2026

Changes in this version

type CacheKV

+ func (c *CacheKV) PutNoCopy(key, value []byte) error

+ func (c *CacheKV) PutNoCopyKeyValueUnsafe(key, value []byte) error

+ func (c *CacheKV) PutNoCopyUnsafe(key, value []byte) error

+ func (c *CacheKV) PutNoCopyValue(key, value []byte) error

type CachedDB

+ func (c *CachedDB) PutNoCopy(key []byte, value []byte) error

+ func (c *CachedDB) PutNoCopyKeyValueUnsafe(key []byte, value []byte) error

+ func (c *CachedDB) PutNoCopyUnsafe(key []byte, value []byte) error

+ func (c *CachedDB) PutNoCopyValue(key []byte, value []byte) error

+ func (c *CachedDB) SetMaxProbeGroupsBeforeResize(groups uint64)

type DB

+ func (h *DB) SetMaxProbeGroupsBeforeResize(groups uint64)

type HashDB

+ func (h *HashDB) PutNoCopy(key []byte, value []byte) error

+ func (h *HashDB) PutNoCopyKeyValueUnsafe(key []byte, value []byte) error

+ func (h *HashDB) PutNoCopyUnsafe(key []byte, value []byte) error

+ func (h *HashDB) PutNoCopyValue(key []byte, value []byte) error

+ func (h *HashDB) SetMaxProbeGroupsBeforeResize(groups uint64)

v0.2.0

Jan 24, 2026

v0.1.0

Jan 23, 2026

Changes in this version

+ const DefaultCapacity

+ const FlagCompressed

+ const FlagControl

+ const OffsetBits

+ const SegmentBits

+ var DefaultIndexMemoryPolicy = IndexMemoryPolicy

+ var ErrLocked = lockfile.ErrLocked

+ var ErrSnapshotCorrupt = errors.New("hashdb: snapshot corrupt")

+ var MaxSegmentSize int64 = 64 * 1024 * 1024

+ type Batch struct

+ func (b *Batch) Close() error

+ func (b *Batch) Commit() error

+ func (b *Batch) CommitSync() error

+ func (b *Batch) Delete(key []byte) error

+ func (b *Batch) Set(key, value []byte) error

+ type BatchOp struct

+ Key []byte

+ Type BatchOpType

+ Value []byte

+ func DeleteOp(key []byte) BatchOp

+ func PutOp(key, value []byte) BatchOp

+ type BatchOpType uint8

+ const BatchOpDelete

+ const BatchOpPut

+ type BatchWriter struct

+ func NewBatchWriter(store *HashDB, limit int) *BatchWriter

+ func (b *BatchWriter) Add(key, value []byte) error

+ func (b *BatchWriter) Flush() error

+ type CacheKV struct

+ func NewCacheKV(backend KVStore, maxEntries, maxBytes int, flushInterval time.Duration) *CacheKV

+ func NewCacheKVWithWAL(backend KVStore, maxEntries, maxBytes int, flushInterval time.Duration, ...) (*CacheKV, error)

+ func (c *CacheKV) Close() error

+ func (c *CacheKV) Delete(key []byte) error

+ func (c *CacheKV) Flush() error

+ func (c *CacheKV) Get(key []byte) ([]byte, error)

+ func (c *CacheKV) Put(key, value []byte) error

+ func (c *CacheKV) SyncWAL() error

+ type CacheWALFsyncPolicy uint8

+ const CacheWALDisabled

+ const CacheWALFsyncAlways

+ const CacheWALFsyncOnSync

+ type CacheWALOptions struct

+ FsyncPolicy CacheWALFsyncPolicy

+ type CachedDB struct

+ func NewCachedDB(folder string, maxEntries, maxBytes int, flushInterval time.Duration) (*CachedDB, error)

+ func NewCachedDBWithOptions(folder string, maxEntries, maxBytes int, flushInterval time.Duration, ...) (*CachedDB, error)

+ func (c *CachedDB) Add(key []byte, value []byte) error

+ func (c *CachedDB) AddMany(items []Item) error

+ func (c *CachedDB) ApplyBatch(ops []BatchOp) error

+ func (c *CachedDB) ApplyBatchSync(ops []BatchOp) error

+ func (c *CachedDB) Clear() error

+ func (c *CachedDB) Close() error

+ func (c *CachedDB) Compact() error

+ func (c *CachedDB) Delete(key []byte) error

+ func (c *CachedDB) DeleteSync(key []byte) error

+ func (c *CachedDB) Flush() error

+ func (c *CachedDB) Get(key []byte) ([]byte, error)

+ func (c *CachedDB) Has(key []byte) (bool, error)

+ func (c *CachedDB) NewBatch() *Batch

+ func (c *CachedDB) Put(key []byte, value []byte) error

+ func (c *CachedDB) PutMany(items []Item) error

+ func (c *CachedDB) PutSync(key []byte, value []byte) error

+ func (c *CachedDB) SetCompression(enabled bool)

+ func (c *CachedDB) Stats() Stats

+ func (c *CachedDB) Sync() error

+ func (c *CachedDB) Update(key []byte, callback func([]byte) ([]byte, error)) error

+ type CachedDBOptions struct

+ CacheWAL CacheWALOptions

+ IndexMemoryPolicy IndexMemoryPolicy

+ IndexMemoryPolicySet bool

+ type CachedHashmap = CachedDB

+ func NewCachedHashmap(folder string, maxEntries, maxBytes int, flushInterval time.Duration) (*CachedHashmap, error)

+ type DB struct

+ func OpenSingle(dir string) (*DB, error)

+ func (h *DB) Add(key []byte, value []byte) error

+ func (h *DB) AddMany(items []Item) error

+ func (h *DB) ApplyBatch(ops []BatchOp) error

+ func (h *DB) ApplyBatchSync(ops []BatchOp) error

+ func (h *DB) Clear() error

+ func (h *DB) Close() error

+ func (h *DB) Compact() error

+ func (h *DB) Delete(key []byte) error

+ func (h *DB) DeleteSync(key []byte) error

+ func (h *DB) Export(w io.Writer) error

+ func (h *DB) ForEach(fn func(key, value []byte) error) error

+ func (h *DB) Get(key []byte) ([]byte, error)

+ func (h *DB) Has(key []byte) (bool, error)

+ func (h *DB) New(folder string) error

+ func (h *DB) NewBatch() *Batch

+ func (h *DB) Open(folder string) error

+ func (h *DB) Put(key []byte, value []byte) error

+ func (h *DB) PutMany(items []Item) error

+ func (h *DB) PutSync(key []byte, value []byte) error

+ func (h *DB) ReadBytes(offset SlabOffset, n int64) ([]byte, error)

+ func (h *DB) Recover() error

+ func (h *DB) Restore(r io.Reader) error

+ func (h *DB) SetCompression(enabled bool)

+ func (h *DB) SetIndexMemoryPolicy(policy IndexMemoryPolicy)

+ func (h *DB) SetResizeThreshold(percent uint64)

+ func (h *DB) Stats() Stats

+ func (h *DB) Sync() error

+ func (h *DB) Update(key []byte, callback func([]byte) ([]byte, error)) error

+ type Hash uint64

+ type HashDB struct

+ func Open(dir string) (*HashDB, error)

+ func OpenWithOptions(dir string, opts HashDBOptions) (*HashDB, error)

+ func OpenWithShards(dir string, numShards int) (*HashDB, error)

+ func OpenWithShardsAndOptions(dir string, numShards int, opts HashDBOptions) (*HashDB, error)

+ func (h *HashDB) Add(key []byte, value []byte) error

+ func (h *HashDB) AddMany(items []Item) error

+ func (h *HashDB) ApplyBatch(ops []BatchOp) error

+ func (h *HashDB) ApplyBatchSync(ops []BatchOp) error

+ func (h *HashDB) Clear() error

+ func (h *HashDB) Close() error

+ func (h *HashDB) Compact() error

+ func (h *HashDB) Delete(key []byte) error

+ func (h *HashDB) DeleteSync(key []byte) error

+ func (h *HashDB) Export(w io.Writer) error

+ func (h *HashDB) Flush() error

+ func (h *HashDB) ForEach(fn func(key, value []byte) error) error

+ func (h *HashDB) Get(key []byte) ([]byte, error)

+ func (h *HashDB) GetMany(keys [][]byte) ([][]byte, []error)

+ func (h *HashDB) Has(key []byte) (bool, error)

+ func (h *HashDB) New(folder string) error

+ func (h *HashDB) NewBatch() *Batch

+ func (h *HashDB) NewWithShards(folder string, numShards int) (err error)

+ func (h *HashDB) NewWithShardsAndOptions(folder string, numShards int, opts HashDBOptions) (err error)

+ func (h *HashDB) Open(folder string) error

+ func (h *HashDB) OpenWithShards(folder string, numShards int) error

+ func (h *HashDB) Put(key []byte, value []byte) error

+ func (h *HashDB) PutMany(items []Item) error

+ func (h *HashDB) PutSync(key []byte, value []byte) error

+ func (h *HashDB) Restore(r io.Reader) error

+ func (h *HashDB) SetCompression(enabled bool)

+ func (h *HashDB) Stats() Stats

+ func (h *HashDB) Sync() error

+ func (h *HashDB) Update(key []byte, callback func([]byte) ([]byte, error)) error

+ type HashDBOptions struct

+ CacheWAL CacheWALOptions

+ IndexMemoryPolicy IndexMemoryPolicy

+ IndexMemoryPolicySet bool

+ type Hashmap = DB

+ type HashmapDistributed = HashDB

+ type IndexMemoryPolicy struct

+ AdviseKeysRandom bool

+ AdviseKeysWillNeed bool

+ LockControls bool

+ LockControlsStrict bool

+ type Item struct

+ Key []byte

+ Value []byte

+ type KVStore interface

+ Delete func(key []byte) error

+ Get func(key []byte) ([]byte, error)

+ Put func(key, value []byte) error

+ type Key struct

+ type ShardedDB = HashDB

+ type SlabOffset uint64

+ const Tombstone

+ type Stats struct

+ Capacity uint64

+ DataSize uint64

+ KeyCount uint64

+ Segments int