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
- API
  
  Reference documentation for the pkg.go.dev API
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

wal

package

Go to main page

Versions in this module

v1

v1.2.2

Aug 19, 2026

v1.2.1

Jul 31, 2026

v1.2.0

Jul 26, 2026

Changes in this version

+ const DefaultSegmentSize

+ const DefaultSize

+ const FlushInterval

+ var ErrAmbiguousLayout = errors.New("wal: legacy and segmented WAL files coexist")

+ var ErrChecksum = errors.New("wal checksum mismatch")

+ var ErrCorruptSegment = errors.New("wal: corrupt segment")

+ var ErrInvalidOptions = errors.New("wal: invalid options")

+ var ErrInvalidPrune = errors.New("wal: prune boundary reaches active segment")

+ var ErrInvalidRecord = errors.New("invalid wal record")

+ var ErrRecordTooLarge = errors.New("wal record too large")

+ func ParseSegmentID(path string) (uint64, bool)

+ func SegmentPath(dir string, id uint64) string

+ type Options struct

+ BufferSize int

+ SegmentMaxRecords uint64

+ SegmentSize int64

+ SyncInterval time.Duration

+ SyncPolicy SyncPolicy

+ func DefaultOptions() Options

+ type Record struct

+ Key []byte

+ Sequence uint64

+ Type RecordType

+ Value []byte

+ func Decode(data []byte) (*Record, error)

+ func DeleteRecord(key []byte) *Record

+ func PutRecord(key []byte, val []byte) *Record

+ func ReadRecord(r io.Reader) (*Record, error)

+ func (r *Record) Encode() ([]byte, error)

+ type RecordType uint8

+ const RecordDelete

+ const RecordPut

+ type RecoveryOptions struct

+ RepairTrailingPartial bool

+ SkipCorruptedRecords bool

+ func DefaultRecoveryOptions() RecoveryOptions

+ type RecoveryReport struct

+ LastSegmentID uint64

+ Records int

+ Segments int

+ SkippedRecords int

+ TruncatedBytes int64

+ func ReplaySegments(dir string, options RecoveryOptions, apply func(*Record) error) (RecoveryReport, error)

+ type Segment struct

+ ID uint64

+ Path string

+ Size int64

+ func ListSegments(dir string) ([]Segment, error)

+ type SyncPolicy uint8

+ const SyncEveryWrite

+ const SyncInterval

+ type WalManger struct

+ Dir string

+ func New(dir string) (*WalManger, error)

+ func NewWithOptions(dir string, options Options) (*WalManger, error)

+ func (wm *WalManger) ActiveSegment() Segment

+ func (wm *WalManger) AppendLog(data []byte) error

+ func (wm *WalManger) AppendRecord(record *Record) error

+ func (wm *WalManger) Background()

+ func (wm *WalManger) Close() error

+ func (wm *WalManger) Err() error

+ func (wm *WalManger) Flush() error

+ func (wm *WalManger) PruneThrough(maxID uint64) (int, error)

+ func (wm *WalManger) Replace(data []byte) error

+ func (wm *WalManger) Reset() error

+ func (wm *WalManger) Rotate() (uint64, error)

+ type WalWriter struct

v1.1.0

Jul 26, 2026