treedb

package

Go to main page

Versions in this module

v0

v0.5.0

Apr 17, 2026

Changes in this version

type DB

+ func (db *DB) LeafGenerationGC(ctx context.Context, opts LeafGenerationGCOptions) (LeafGenerationGCStats, error)

+ func (db *DB) LeafGenerationPack(ctx context.Context, opts LeafGenerationPackOptions) (LeafGenerationPackStats, error)

+ func (db *DB) LeafGenerationPackFromPlan(ctx context.Context, opts LeafGenerationPackFromPlanOptions) (LeafGenerationPackStats, error)

+ func (db *DB) LeafGenerationPackRunOnce(ctx context.Context, opts LeafGenerationPackFromPlanOptions) (LeafGenerationPackRunOnceStats, error)

+ func (db *DB) LeafGenerationPlan(ctx context.Context, opts LeafGenerationPlanOptions) (LeafGenerationPlan, error)

+ type LeafGenerationGCOptions struct

+ DryRun bool

+ type LeafGenerationGCStats struct

+ FilesDeleted int

+ GenerationsDeleted int

+ GenerationsEligible int

+ GenerationsLive int

+ GenerationsRetiring int

+ GenerationsTotal int

+ GenerationsWritable int

+ type LeafGenerationPackFromPlanOptions = treedbdb.LeafGenerationPackFromPlanOptions

+ type LeafGenerationPackOptions = treedbdb.LeafGenerationPackOptions

+ type LeafGenerationPackRunOnceStats = treedbdb.LeafGenerationPackRunOnceStats

+ type LeafGenerationPackSelectOptions = treedbdb.LeafGenerationPackSelectOptions

+ type LeafGenerationPackSelection = treedbdb.LeafGenerationPackSelection

+ func SelectLeafGenerationPackCandidates(plan LeafGenerationPlan, opts LeafGenerationPackSelectOptions) (LeafGenerationPackSelection, error)

+ type LeafGenerationPackStats = treedbdb.LeafGenerationPackStats

+ type LeafGenerationPlan = treedbdb.LeafGenerationPlan

+ type LeafGenerationPlanGeneration = treedbdb.LeafGenerationPlanGeneration

+ type LeafGenerationPlanOptions = treedbdb.LeafGenerationPlanOptions

v0.4.0

Apr 3, 2026

Changes in this version

+ const MaintenancePhaseCatchUp

+ const MaintenancePhaseRestore

+ const MaintenancePhaseSteady

+ const ValueLogDictClassSingle

+ const ValueLogDictClassSplitOuterLeaf

+ const ValueLogGenerationDefault

+ const ValueLogGenerationHotWarmCold

+ const ValueLogGenerationOff

+ const ValueLogRewriteLocalityDefault

+ const ValueLogRewriteLocalityGrouped

type DB

+ func (db *DB) GetMany(keys [][]byte) ([][]byte, error)

+ func (db *DB) GetManyParallelPlan(keyCount int) (workers int, parallel bool)

+ func (db *DB) MaintenancePhase() MaintenancePhase

+ func (db *DB) SetMaintenancePhase(phase MaintenancePhase)

+ func (db *DB) ValueLogRewriteOnline(ctx context.Context, opts ValueLogRewriteOnlineOptions) (ValueLogRewriteStats, error)

+ type MaintenancePhase = caching.MaintenancePhase

type Snapshot

+ Close func() error

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

+ GetAppend func(key, dst []byte) ([]byte, error)

+ GetEntry func(key []byte) (node.LeafEntry, error)

+ GetEntryExact func(key []byte) (node.LeafEntry, error)

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

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

+ Pager func() *pager.Pager

+ State func() *backenddb.DBState

+ type ValueLogDictClassMode = db.ValueLogDictClassMode

+ type ValueLogDomainThreshold = db.ValueLogDomainThreshold

+ type ValueLogGCMode string

+ const ValueLogGCModeOnline

+ const ValueLogGCModeStrict

type ValueLogGCOptions

+ Mode ValueLogGCMode

type ValueLogGCStats

+ BytesProtected int64

+ FailClosedToDryRun bool

+ SegmentsProtected int

+ type ValueLogGenerationConfig = db.ValueLogGenerationConfig

+ type ValueLogGenerationPolicy = db.ValueLogGenerationPolicy

+ type ValueLogRewriteLocalityPolicy = treedbdb.ValueLogRewriteLocalityPolicy

+ type ValueLogRewriteOnlineOptions = treedbdb.ValueLogRewriteOnlineOptions

v0.3.0

Feb 7, 2026

Changes in this version

+ const AutotuneAggressive

+ const AutotuneMedium

+ const AutotuneOff

+ const AutotuneUnset

+ const DurabilityDurable

+ const DurabilityWALOffRelaxed

+ const DurabilityWALOnRelaxed

+ const IntegritySkipChecksums

+ const IntegrityVerify

+ const ValueLogAutoBalanced

+ const ValueLogAutoSize

+ const ValueLogAutoThroughput

+ const ValueLogBlockLZ4

+ const ValueLogBlockSnappy

+ const ValueLogCompressionAuto

+ const ValueLogCompressionBlock

+ const ValueLogCompressionDict

+ const ValueLogCompressionOff

+ const ZSTDLevelBest

+ const ZSTDLevelBetter

+ const ZSTDLevelDefault

+ const ZSTDLevelFastest

+ func DisableValueLogDictCompression(opts *Options)

+ func EnableValueLogDictCompression(opts *Options)

+ type AutotuneMode = valuelog.AutotuneMode

+ type AutotuneOptions = valuelog.AutotuneOptions

type DB

+ func (db *DB) ValueLogGC(ctx context.Context, opts ValueLogGCOptions) (ValueLogGCStats, error)

+ type DictLookup = valuelog.DictLookup

+ type DurabilityMode = db.DurabilityMode

+ type IntegrityMode = db.IntegrityMode

type Profile

+ const ProfileWALOnFast

+ type TrainConfig = compression.TrainConfig

+ type ValueLogAutoPolicy = db.ValueLogAutoPolicy

+ type ValueLogBlockCodec = db.ValueLogBlockCodec

+ type ValueLogCompressionMode = db.ValueLogCompressionMode

+ type ValueLogGCOptions struct

+ DryRun bool

+ type ValueLogGCStats struct

+ BytesActive int64

+ BytesDeleted int64

+ BytesEligible int64

+ BytesReferenced int64

+ BytesTotal int64

+ SegmentsActive int

+ SegmentsDeleted int

+ SegmentsEligible int

+ SegmentsReferenced int

+ SegmentsTotal int

+ type ValueLogOptions = db.ValueLogOptions

+ type ValueLogRewriteStats struct

+ BytesAfter int64

+ BytesBefore int64

+ RecordsCopied int

+ SegmentsAfter int

+ SegmentsBefore int

+ func ValueLogRewriteOffline(opts Options) (ValueLogRewriteStats, error)

+ type ZSTDEncoderLevel = zstd.EncoderLevel

v0.2.0

Jan 24, 2026

Changes in this version

type Profile

+ const ProfileFastIngest

v0.1.0

Jan 23, 2026

Changes in this version

+ const ModeBackend

+ const ModeCached

+ var ErrClosed = errors.New("treedb: db is closed")

+ var ErrKeyNotFound = tree.ErrKeyNotFound

+ var ErrLocked = db.ErrLocked

+ var ErrMemtableFull = caching.ErrMemtableFull

+ var ErrMemtableValueLogPointers = caching.ErrMemtableValueLogPointers

+ var ErrUnsafeOptions = db.ErrUnsafeOptions

+ func ApplyProfile(opts *Options, profile Profile)

+ func VacuumIndexOffline(opts Options) error

+ type Batch interface

+ Close func() error

+ Delete func(key []byte) error

+ GetByteSize func() (int, error)

+ Replay func(func(batch.Entry) error) error

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

+ Write func() error

+ WriteSync func() error

+ type DB struct

+ func Open(opts Options) (*DB, error)

+ func OpenBackend(opts Options) (*DB, error)

+ func OpenCached(opts Options) (*DB, error)

+ func (db *DB) AcquireSnapshot() *Snapshot

+ func (db *DB) Checkpoint() error

+ func (db *DB) Close() error

+ func (db *DB) CompactCandidates(opts compaction.Options) error

+ func (db *DB) CompactIndex() error

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

+ func (db *DB) DeleteRange(start, end []byte) error

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

+ func (db *DB) DurabilityMode() string

+ func (db *DB) FragmentationReport() (map[string]string, error)

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

+ func (db *DB) GetAppend(key, dst []byte) ([]byte, error)

+ func (db *DB) GetUnsafe(key []byte) ([]byte, error)

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

+ func (db *DB) Iterator(start, end []byte) (Iterator, error)

+ func (db *DB) NewBatch() Batch

+ func (db *DB) NewBatchWithSize(size int) Batch

+ func (db *DB) Print() error

+ func (db *DB) ReverseIterator(start, end []byte) (Iterator, error)

+ func (db *DB) Set(key, value []byte) error

+ func (db *DB) SetSync(key, value []byte) error

+ func (db *DB) Stats() map[string]string

+ func (db *DB) VacuumIndexOnline(ctx context.Context) error

+ type Iterator interface

+ Close func() error

+ Error func() error

+ Key func() []byte

+ KeyCopy func(dst []byte) []byte

+ Next func()

+ Valid func() bool

+ Value func() []byte

+ ValueCopy func(dst []byte) []byte

+ type Mode = db.Mode

+ type Options = db.Options

+ func OptionsFor(profile Profile, dir string) Options

+ type Profile string

+ const ProfileBench

+ const ProfileDurable

+ const ProfileFast

+ type Snapshot = db.Snapshot

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL