README
¶
Embedded Write Ahead Log
Simple multi segment write ahead log. Writes two type of files files *.index and *.store. Configurable maximum index and store file sizes.
Files stucuture:
- Index record structure: [recordID (8 bytes)][recordOffset (8 bytes)]
- Store record structure: [size (8 bytes)][data (variable bytes)]
Usage example
wl, _ := wal.New(".", nil)
offset, _ := wl.Append(data)
data, _ := wl.Read(offset)
wl.Close()
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrRecordNotFound = errors.New("record is not found") ErrIndexRecordID = errors.New("cant read record id from index") )
View Source
var ErrMaxIndexSize = errors.New("max index size should be multiple by 16 and more than 0")
Functions ¶
This section is empty.
Types ¶
type Config ¶
Config stores embedded log configuration data MaxIndexSizeBytes should be multiple of 16
type WAL ¶
type WAL struct {
// contains filtered or unexported fields
}
func New ¶
New creates a Write Ahead Log in specified directory it will look for files [d+].store and [d+].index if no such files are present it will create an empty ones: 0001.index and 0001.store
Source Files
Click to show internal directories.
Click to hide internal directories.