wal

Oct 24, 2021

Changes in this version

type Wal

+ ReadTo func(_entry encoding.BinaryUnmarshaler, _seqNum uint64) error

+ WriteFrom func(r encoding.BinaryMarshaler) (uint64, error)

Jun 9, 2021

Changes in this version

type Envelope

+ Err error

Feb 15, 2021

Changes in this version

+ var ErrSeqNumOutOfRange = fmt.Errorf("sequence number is out of range")

+ type Envelope struct

+ Payload []byte

+ SeqNum uint64

type Wal

+ Read func(_seqNum uint64) ([]byte, error)

+ ReadFrom func(_seqNum uint64, _n int64) (<-chan Envelope, error)

+ Safe func() uint64

+ Sync func() (uint64, error)

Feb 7, 2021

Changes in this version

+ var ErrEntryNotFound = fmt.Errorf("entry not found")

+ var ErrNoData = fmt.Errorf("no data provided")

+ type Entry interface

+ Marshal func() (_data []byte, err error)

+ Unmarshal func(_data []byte) error

type Wal

+ func Open(_name string, _segSplit int64, _segSize int64) (Wal, error)

+ First func() uint64

+ Name func() string

+ ReadAt func(_entry Entry, _seqNum uint64) error

+ SeqNum func() uint64

+ Truncate func(_seqNum uint64) error

Dec 20, 2019

Changes in this version

+ var ErrNoRecordFound = errors.New("no record found")

+ var ErrNotEnoughBytes = errors.New("not enough bytes to create a record struct")

+ var ErrSegmentFileClosed = errors.New("the segmentFile file is closed")

+ var ErrWalClosed = errors.New("the wal is closed")

+ type CompactionConfig struct

+ ExpirationThreshold time.Duration

+ KeepAmount uint64

+ Strategy CompactionStrategyType

+ Trigger CompactionTriggerType

+ TriggerInterval time.Duration

+ type CompactionStrategyType int8

+ const StrategyExpire

+ const StrategyKeep

+ type CompactionTriggerType int8

+ const TriggerManually

+ const TriggerNone

+ const TriggerTime

+ type Config struct

+ Compaction CompactionConfig

+ RecordCollectionSliceAlloc uint64

+ SegmentFileDir string

+ SegmentFilePrefix string

+ SegmentIndexTableAlloc uint64

+ SegmentMaxSizeBytes int64

+ func (c Config) Validate() error

+ type DiskWal struct

+ func (l *DiskWal) Close() error

+ func (l *DiskWal) Compact() error

+ func (l *DiskWal) CompareAndWrite(version uint64, record *Record) error

+ func (l *DiskWal) Delete(key Key) error

+ func (l *DiskWal) ReadAll(key Key) ([]Record, error)

+ func (l *DiskWal) ReadLatest(key Key, record *Record) error

+ func (l *DiskWal) ReadSequenceNum(sequenceNum uint64, record *Record) error

+ func (l *DiskWal) Remove() error

+ func (l *DiskWal) SegmentAmount() uint64

+ func (l *DiskWal) Write(record *Record) error

+ type Key []byte

+ func (k Key) HashSum64() uint64

+ type Record struct

+ Data []byte

+ Key Key

+ func (r *Record) FromBytes(recordBytes []byte) error

+ func (r *Record) ToBytes() []byte

+ func (r Record) CreatedAt() time.Time

+ func (r Record) DeletionMarker() bool

+ func (r Record) Offset() int64

+ func (r Record) SequenceNumber() uint64

+ func (r Record) Size() int64

+ func (r Record) Version() uint64

+ type StrategyExpireCompaction struct

+ func (s *StrategyExpireCompaction) Scan(segment segment) ([]int64, bool)

+ func (s *StrategyExpireCompaction) Validate() error

+ type StrategyKeepLatestCompaction struct

+ func (s *StrategyKeepLatestCompaction) Scan(segment segment) ([]int64, bool)

+ func (s *StrategyKeepLatestCompaction) Validate() error

+ type Wal interface

+ Close func() error

+ Compact func() error

+ CompareAndWrite func(version uint64, record *Record) error

+ Delete func(key Key) error

+ ReadAll func(key Key) ([]Record, error)

+ ReadLatest func(key Key, record *Record) error

+ ReadSequenceNum func(sequenceNum uint64, record *Record) error

+ Remove func() error

+ SegmentAmount func() uint64

+ Write func(record *Record) error

+ func Bootstrap(config Config) (Wal, error)