litestream

Oct 20, 2023

Changes in this version

+ const DefaultTruncatePageN

type DB

+ TruncatePageN int

Aug 8, 2023

Changes in this version

+ var LogFlags = 0

+ var LogWriter = os.Stdout

type DB

+ Logger *log.Logger

+ func (db *DB) BeginSnapshot()

+ func (db *DB) EndSnapshot()

+ func (db *DB) SetMetaPath(mp string)

type Replica

+ AgeIdentities []age.Identity

+ AgeRecipients []age.Recipient

+ Logger *log.Logger

Jun 6, 2021

Changes in this version

+ const DefaultSyncInterval

+ const WALSegmentExt

+ func FormatSnapshotPath(index int) string

+ func FormatWALSegmentPath(index int, offset int64) string

+ func GenerationPath(root, generation string) (string, error)

+ func GenerationsPath(root string) string

+ func ParseWALSegmentPath(s string) (index int, offset int64, err error)

+ func SnapshotPath(root, generation string, index int) (string, error)

+ func SnapshotsPath(root, generation string) (string, error)

+ func WALPath(root, generation string) (string, error)

+ func WALSegmentPath(root, generation string, index int, offset int64) (string, error)

type DB

+ func (db *DB) DirInfo() os.FileInfo

+ func (db *DB) FileInfo() os.FileInfo

type Pos

+ func (p Pos) Truncate() Pos

type Replica

+ Client ReplicaClient

+ MonitorEnabled bool

+ Retention time.Duration

+ RetentionCheckInterval time.Duration

+ SnapshotInterval time.Duration

+ SyncInterval time.Duration

+ ValidationInterval time.Duration

+ func NewReplica(db *DB, name string) *Replica

+ func (r *Replica) CalcRestoreTarget(ctx context.Context, opt RestoreOptions) (generation string, updatedAt time.Time, err error)

+ func (r *Replica) EnforceRetention(ctx context.Context) (err error)

+ func (r *Replica) GenerationCreatedAt(ctx context.Context, generation string) (time.Time, error)

+ func (r *Replica) GenerationTimeBounds(ctx context.Context, generation string) (createdAt, updatedAt time.Time, err error)

+ func (r *Replica) Pos() Pos

+ func (r *Replica) Restore(ctx context.Context, opt RestoreOptions) (err error)

+ func (r *Replica) Snapshot(ctx context.Context) (info SnapshotInfo, err error)

+ func (r *Replica) SnapshotIndexByIndex(ctx context.Context, generation string, index int) (int, error)

+ func (r *Replica) Validate(ctx context.Context) error

+ type ReplicaClient interface

+ DeleteGeneration func(ctx context.Context, generation string) error

+ DeleteSnapshot func(ctx context.Context, generation string, index int) error

+ DeleteWALSegments func(ctx context.Context, a []Pos) error

+ Generations func(ctx context.Context) ([]string, error)

+ SnapshotReader func(ctx context.Context, generation string, index int) (io.ReadCloser, error)

+ Snapshots func(ctx context.Context, generation string) (SnapshotIterator, error)

+ Type func() string

+ WALSegmentReader func(ctx context.Context, pos Pos) (io.ReadCloser, error)

+ WALSegments func(ctx context.Context, generation string) (WALSegmentIterator, error)

+ WriteSnapshot func(ctx context.Context, generation string, index int, r io.Reader) (SnapshotInfo, error)

+ WriteWALSegment func(ctx context.Context, pos Pos, r io.Reader) (WALSegmentInfo, error)

type SnapshotInfo

+ func SliceSnapshotIterator(itr SnapshotIterator) ([]SnapshotInfo, error)

+ func (info *SnapshotInfo) Pos() Pos

+ type SnapshotInfoSlice []SnapshotInfo

+ func (a SnapshotInfoSlice) Len() int

+ func (a SnapshotInfoSlice) Less(i, j int) bool

+ func (a SnapshotInfoSlice) Swap(i, j int)

+ type SnapshotInfoSliceIterator struct

+ func NewSnapshotInfoSliceIterator(a []SnapshotInfo) *SnapshotInfoSliceIterator

+ func (itr *SnapshotInfoSliceIterator) Close() error

+ func (itr *SnapshotInfoSliceIterator) Err() error

+ func (itr *SnapshotInfoSliceIterator) Next() bool

+ func (itr *SnapshotInfoSliceIterator) Snapshot() SnapshotInfo

+ type SnapshotIterator interface

+ Err func() error

+ Next func() bool

+ Snapshot func() SnapshotInfo

+ type WALInfoSlice []WALInfo

+ func (a WALInfoSlice) Len() int

+ func (a WALInfoSlice) Less(i, j int) bool

+ func (a WALInfoSlice) Swap(i, j int)

+ type WALSegmentInfo struct

+ CreatedAt time.Time

+ Generation string

+ Index int

+ Offset int64

+ Size int64

+ func SliceWALSegmentIterator(itr WALSegmentIterator) ([]WALSegmentInfo, error)

+ func (info *WALSegmentInfo) Pos() Pos

+ type WALSegmentInfoSlice []WALSegmentInfo

+ func (a WALSegmentInfoSlice) Len() int

+ func (a WALSegmentInfoSlice) Less(i, j int) bool

+ func (a WALSegmentInfoSlice) Swap(i, j int)

+ type WALSegmentInfoSliceIterator struct

+ func NewWALSegmentInfoSliceIterator(a []WALSegmentInfo) *WALSegmentInfoSliceIterator

+ func (itr *WALSegmentInfoSliceIterator) Close() error

+ func (itr *WALSegmentInfoSliceIterator) Err() error

+ func (itr *WALSegmentInfoSliceIterator) Next() bool

+ func (itr *WALSegmentInfoSliceIterator) WALSegment() WALSegmentInfo

+ type WALSegmentIterator interface

+ Err func() error

+ Next func() bool

+ WALSegment func() WALSegmentInfo

Apr 24, 2021

Changes in this version

+ const DefaultRestoreParallelism

+ func SnapshotIndexByIndex(ctx context.Context, r Replica, generation string, index int) (int, error)

type Replica

+ Sync func(ctx context.Context) error

type RestoreOptions

+ Parallelism int

Mar 11, 2021

Changes in this version

+ var ErrNoGeneration = errors.New("no generation available")

type FileReplica

+ SnapshotInterval time.Duration

+ func (r *FileReplica) Snapshot(ctx context.Context) error

Feb 9, 2021

Changes in this version

+ const MaxIndex

type RestoreOptions

+ Verbose bool

type ShadowWALReader

+ func (r *ShadowWALReader) Name() string

Jan 27, 2021

Changes in this version

+ func RestoreReplica(ctx context.Context, r Replica, opt RestoreOptions) error

type DB

+ func (db *DB) CalcRestoreTarget(ctx context.Context, opt RestoreOptions) (Replica, string, error)

type GenerationStats

+ func CalcReplicaRestoreTarget(ctx context.Context, r Replica, opt RestoreOptions) (generation string, stats GenerationStats, err error)

Jan 21, 2021

Changes in this version

+ const BusyTimeout

+ const DefaultMaxCheckpointPageN

+ const DefaultRetention

+ const DefaultRetentionCheckInterval

+ var Tracef = func(format string, a ...interface{})

+ func SnapshotIndexAt(ctx context.Context, r Replica, generation string, timestamp time.Time) (int, error)

+ func ValidateReplica(ctx context.Context, r Replica) error

+ func WALIndexAt(ctx context.Context, r Replica, generation string, maxIndex int, ...) (int, error)

type DB

+ func (db *DB) CRC64() (uint64, Pos, error)

+ func (db *DB) Checkpoint(mode string) (err error)

+ func (db *DB) SQLDB() *sql.DB

type FileReplica

+ MonitorEnabled bool

+ Retention time.Duration

+ RetentionCheckInterval time.Duration

+ ValidationInterval time.Duration

+ func (r *FileReplica) DB() *DB

+ func (r *FileReplica) EnforceRetention(ctx context.Context) (err error)

+ func (r *FileReplica) GenerationDir(generation string) string

+ func (r *FileReplica) Path() string

type Replica

+ DB func() *DB

type SnapshotInfo

+ func FilterSnapshotsAfter(a []*SnapshotInfo, t time.Time) []*SnapshotInfo

+ func FindMinSnapshotByGeneration(a []*SnapshotInfo, generation string) *SnapshotInfo

Dec 31, 2020

Changes in this version

+ const CheckpointModeFull

+ const CheckpointModePassive

+ const CheckpointModeRestart

+ const CheckpointModeTruncate

+ const DefaultCheckpointInterval

+ var ErrChecksumMismatch = errors.New("invalid replica, checksum mismatch")

+ func FormatWALPath(index int) string

+ func FormatWALPathWithOffset(index int, offset int64) string

type DB

+ CheckpointInterval time.Duration

+ func (db *DB) CRC32C() (uint32, Pos, error)

+ func (db *DB) Pos() (Pos, error)

+ func (db *DB) Replica(name string) Replica

+ func (db *DB) ShadowWALDir(generation string) string

+ func (db *DB) Snapshots(ctx context.Context) ([]*SnapshotInfo, error)

+ func (db *DB) Validate(ctx context.Context, replicaName string, opt RestoreOptions) error

+ func (db *DB) WALs(ctx context.Context) ([]*WALInfo, error)

type FileReplica

+ func (r *FileReplica) CalcPos(generation string) (pos Pos, err error)

+ func (r *FileReplica) LastPos() Pos

+ func (r *FileReplica) MaxSnapshotIndex(generation string) (int, error)

+ func (r *FileReplica) MaxWALSubdirName(generation string) (string, error)

+ func (r *FileReplica) Snapshots(ctx context.Context) ([]*SnapshotInfo, error)

+ func (r *FileReplica) Sync(ctx context.Context) (err error)

+ func (r *FileReplica) WALSubdir(generation string, index int) string

+ func (r *FileReplica) WALSubdirNames(generation string) ([]string, error)

+ func (r *FileReplica) WALs(ctx context.Context) ([]*WALInfo, error)

type Replica

+ CalcPos func(generation string) (Pos, error)

+ LastPos func() Pos

+ Snapshots func(ctx context.Context) ([]*SnapshotInfo, error)

+ WALs func(ctx context.Context) ([]*WALInfo, error)

type RestoreOptions

+ Index int

+ func NewRestoreOptions() RestoreOptions

+ type SnapshotInfo struct

+ CreatedAt time.Time

+ Generation string

+ Index int

+ Name string

+ Replica string

+ Size int64

+ type WALInfo struct

+ CreatedAt time.Time

+ Generation string

+ Index int

+ Name string

+ Offset int64

+ Replica string

+ Size int64

Dec 29, 2020

Changes in this version

+ const DefaultMinCheckpointPageN

+ const DefaultMonitorInterval

+ const GenerationNameLen

+ const MetaDirSuffix

+ const SnapshotExt

+ const WALDirName

+ const WALExt

+ const WALFrameHeaderChecksumOffset

+ const WALFrameHeaderSize

+ const WALHeaderChecksumOffset

+ const WALHeaderSize

+ var ErrNoSnapshots = errors.New("no snapshots available")

+ func Checksum(bo binary.ByteOrder, s0, s1 uint32, b []byte) (uint32, uint32)

+ func FormatWALFilename(index int) string

+ func HexDump(b []byte) string

+ func IsGenerationName(s string) bool

+ func IsSnapshotPath(s string) bool

+ func IsWALPath(s string) bool

+ func ParseSnapshotPath(s string) (index int, typ, ext string, err error)

+ func ParseWALFilename(name string) (index int, err error)

+ func ParseWALPath(s string) (index int, offset int64, ext string, err error)

+ type DB struct

+ MaxCheckpointPageN int

+ MinCheckpointPageN int

+ MonitorInterval time.Duration

+ Replicas []Replica

+ func NewDB(path string) *DB

+ func (db *DB) Close() (err error)

+ func (db *DB) CurrentGeneration() (string, error)

+ func (db *DB) CurrentShadowWALIndex(generation string) (int, error)

+ func (db *DB) CurrentShadowWALPath(generation string) (string, error)

+ func (db *DB) GenerationNamePath() string

+ func (db *DB) GenerationPath(generation string) string

+ func (db *DB) Init() (err error)

+ func (db *DB) MetaPath() string

+ func (db *DB) Notify() <-chan struct{}

+ func (db *DB) Open() (err error)

+ func (db *DB) PageSize() int

+ func (db *DB) Path() string

+ func (db *DB) Restore(ctx context.Context, opt RestoreOptions) error

+ func (db *DB) ShadowWALPath(generation string, index int) string

+ func (db *DB) ShadowWALReader(pos Pos) (r *ShadowWALReader, err error)

+ func (db *DB) SoftClose() (err error)

+ func (db *DB) Sync() (err error)

+ func (db *DB) UpdatedAt() (time.Time, error)

+ func (db *DB) WALPath() string

+ type FileReplica struct

+ func NewFileReplica(db *DB, name, dst string) *FileReplica

+ func (r *FileReplica) GenerationStats(ctx context.Context, generation string) (stats GenerationStats, err error)

+ func (r *FileReplica) Generations(ctx context.Context) ([]string, error)

+ func (r *FileReplica) Name() string

+ func (r *FileReplica) SnapshotDir(generation string) string

+ func (r *FileReplica) SnapshotIndexAt(ctx context.Context, generation string, timestamp time.Time) (int, error)

+ func (r *FileReplica) SnapshotPath(generation string, index int) string

+ func (r *FileReplica) SnapshotReader(ctx context.Context, generation string, index int) (io.ReadCloser, error)

+ func (r *FileReplica) Start(ctx context.Context)

+ func (r *FileReplica) Stop()

+ func (r *FileReplica) Type() string

+ func (r *FileReplica) WALDir(generation string) string

+ func (r *FileReplica) WALIndexAt(ctx context.Context, generation string, timestamp time.Time) (int, error)

+ func (r *FileReplica) WALPath(generation string, index int) string

+ func (r *FileReplica) WALReader(ctx context.Context, generation string, index int) (io.ReadCloser, error)

+ type GenerationStats struct

+ CreatedAt time.Time

+ SnapshotN int

+ UpdatedAt time.Time

+ WALN int

+ type Pos struct

+ Generation string

+ Index int

+ Offset int64

+ func (p Pos) IsZero() bool

+ func (p Pos) String() string

+ type Replica interface

+ GenerationStats func(ctx context.Context, generation string) (GenerationStats, error)

+ Generations func(ctx context.Context) ([]string, error)

+ Name func() string

+ SnapshotIndexAt func(ctx context.Context, generation string, timestamp time.Time) (int, error)

+ SnapshotReader func(ctx context.Context, generation string, index int) (io.ReadCloser, error)

+ Start func(ctx context.Context)

+ Stop func()

+ Type func() string

+ WALIndexAt func(ctx context.Context, generation string, timestamp time.Time) (int, error)

+ WALReader func(ctx context.Context, generation string, index int) (io.ReadCloser, error)

+ type RestoreOptions struct

+ DryRun bool

+ Generation string

+ Logger *log.Logger

+ OutputPath string

+ ReplicaName string

+ Timestamp time.Time

+ type ShadowWALReader struct

+ func (r *ShadowWALReader) Close() error

+ func (r *ShadowWALReader) N() int64

+ func (r *ShadowWALReader) Pos() Pos

+ func (r *ShadowWALReader) Read(p []byte) (n int, err error)