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

storage

package

Go to main page

Versions in this module

v1

v1.1.0

Mar 15, 2026

Changes in this version

+ type CompactionResult struct

+ InputTables int

+ MergedEntries int

+ OutputSize int64

type Log

+ FindOffsetByTimestamp func(timestamp int64) (Offset, int64, error)

type MessageBatch

+ LeaderEpoch int64

+ type RetentionConfig struct

+ CheckInterval time.Duration

+ RetentionBytes int64

+ RetentionMs int64

+ func DefaultRetentionConfig() RetentionConfig

+ type RetentionManager struct

+ func NewRetentionManager(config RetentionConfig) *RetentionManager

+ func (rm *RetentionManager) EnforceNow() RetentionStats

+ func (rm *RetentionManager) RegisterLog(partitionID string, log Log)

+ func (rm *RetentionManager) Start(ctx context.Context)

+ func (rm *RetentionManager) Stats() RetentionStats

+ func (rm *RetentionManager) Stop()

+ func (rm *RetentionManager) UnregisterLog(partitionID string)

+ type RetentionStats struct

+ BytesReclaimed int64

+ PartitionsChecked int64

+ SegmentsDeleted int64

v1.0.1

Nov 22, 2025

Changes in this version

+ var ErrChecksumMismatch = errors.New("checksum mismatch")

+ var ErrInvalidOffset = errors.New("invalid offset")

+ var ErrLogClosed = errors.New("log is closed")

+ var ErrLogCorrupted = errors.New("log is corrupted")

+ var ErrOffsetOutOfRange = errors.New("offset out of range")

+ var ErrSegmentNotFound = errors.New("segment not found")

+ type CompactionConfig struct

+ MaxConcurrent int

+ SizeRatio int

+ Strategy CompactionStrategy

+ type CompactionStrategy int

+ const CompactionLeveled

+ const CompactionSizeTiered

+ const CompactionTimeWindow

+ type CompressionType int8

+ const CompressionGzip

+ const CompressionLZ4

+ const CompressionNone

+ const CompressionSnappy

+ const CompressionZstd

+ type Config struct

+ Compaction CompactionConfig

+ DataDir string

+ MemTable MemTableConfig

+ SSTable SSTableConfig

+ WAL WALConfig

+ func DefaultConfig() *Config

+ type FsyncPolicy int

+ const FsyncAlways

+ const FsyncInterval

+ const FsyncNever

+ type Index interface

+ Add func(offset Offset, position int64) error

+ Close func() error

+ Lookup func(offset Offset) (position int64, err error)

+ Sync func() error

+ Truncate func(beforeOffset Offset) error

+ func NewIndex(path string) (Index, error)

+ type Iterator interface

+ Close func() error

+ Err func() error

+ Key func() []byte

+ Next func() bool

+ Value func() []byte

+ type Log interface

+ Append func(batch *MessageBatch) ([]Offset, error)

+ Close func() error

+ Compact func() error

+ Delete func(beforeOffset Offset) error

+ EndOffset func() Offset

+ Flush func() error

+ HighWaterMark func() Offset

+ Read func(offset Offset, maxBytes int) ([]*Message, error)

+ ReadRange func(startOffset, endOffset Offset) ([]*Message, error)

+ StartOffset func() Offset

+ func NewLog(dir string, config Config) (Log, error)

+ type MemTable interface

+ Clear func()

+ Delete func(key []byte) error

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

+ Iterator func() Iterator

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

+ Size func() int64

+ func NewMemTable() MemTable

+ type MemTableConfig struct

+ MaxSize int64

+ NumImmutable int

+ type Message struct

+ CRC uint32

+ Headers map[string][]byte

+ Key []byte

+ Offset Offset

+ Timestamp time.Time

+ Value []byte

+ type MessageBatch struct

+ BaseOffset Offset

+ Compression CompressionType

+ Messages []Message

+ ProducerEpoch int16

+ ProducerID int64

+ Timestamp time.Time

+ type Offset int64

+ type SSTable interface

+ Close func() error

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

+ Iterator func() Iterator

+ type SSTableConfig struct

+ BlockSize int

+ BloomFilterEnabled bool

+ BloomFilterFPRate float64

+ Compression CompressionType

+ type Segment interface

+ Append func(batch *MessageBatch) error

+ BaseOffset func() Offset

+ Close func() error

+ IsFull func() bool

+ NextOffset func() Offset

+ Read func(offset Offset, maxBytes int) ([]*Message, error)

+ Size func() int64

+ Sync func() error

+ type Storage interface

+ Append func(ctx context.Context, partition int, batch *MessageBatch) ([]Offset, error)

+ Close func() error

+ Compact func(partition int) error

+ Delete func(partition int, beforeOffset Offset) error

+ Flush func() error

+ GetHighWaterMark func(partition int) (Offset, error)

+ GetLogEndOffset func(partition int) (Offset, error)

+ GetLogStartOffset func(partition int) (Offset, error)

+ Read func(ctx context.Context, partition int, offset Offset, maxBytes int) ([]*Message, error)

+ ReadRange func(ctx context.Context, partition int, startOffset, endOffset Offset) ([]*Message, error)

+ type WAL interface

+ Append func(data []byte) (Offset, error)

+ Close func() error

+ NextOffset func() Offset

+ Read func(offset Offset) ([]byte, error)

+ Sync func() error

+ Truncate func(beforeOffset Offset) error

+ func NewWAL(dir string, config WALConfig) (WAL, error)

+ type WALConfig struct

+ FsyncInterval time.Duration

+ FsyncPolicy FsyncPolicy

+ SegmentSize int64