checkpoint

package

v0.3.2 Latest Latest Go to latest Published: Mar 26, 2026 License: MIT Imports: 1 Imported by: 0

Details

Package checkpoint defines WAL checkpoint modes for SQLite.

This section is empty.

View Source

var ErrInvalidMode = fmt.Errorf("invalid checkpoint mode")

ErrInvalidMode is returned when a checkpoint mode is not recognised.

This section is empty.

type Mode string

Mode defines the WAL checkpoint behaviour on close. These map directly to SQLite's PRAGMA wal_checkpoint modes.

const (
	None     Mode = ""
	Passive  Mode = "PASSIVE"
	Full     Mode = "FULL"
	Restart  Mode = "RESTART"
	Truncate Mode = "TRUNCATE"
)

Checkpoint modes for use with the Checkpoint() builder method.

func (m Mode) Valid() bool

Valid reports whether m is a recognised checkpoint mode.