wal

Documentation

Index

• type Manager
• type WAL

Types

type Manager

type Manager interface {
	// CreateWAL returns a new WAL instance.
	CreateWAL(context.Context, partition.ID) (WAL, error)
	// DiscoverWALs discovers all the existing WALs.
	// This is used to recover from a restart and replay all the messages from the WAL.
	DiscoverWALs(context.Context) ([]WAL, error)
	// DeleteWAL deletes the WAL.
	DeleteWAL(partition.ID) error
}

Manager defines the interface to manage the WALs.

type WAL

type WAL interface {
	// Replay to replay persisted messages during startup
	// returns a channel to read messages and a channel to read errors
	Replay() (<-chan *isb.ReadMessage, <-chan error)
	// Write writes message to the WAL.
	Write(msg *isb.ReadMessage) error
	// PartitionID returns the partition ID of the WAL.
	PartitionID() *partition.ID
	// Close closes WAL.
	Close() error
}

WAL provides methods to read, write and delete data from the WAL.