file

package

v0.5.0 Latest Latest Go to latest Published: Sep 30, 2025 License: Apache-2.0 Imports: 7 Imported by: 1

Details

View Source

const ReplicaClientType = "file"

ReplicaClientType is the client type for this package.

This section is empty.

This section is empty.

type ReplicaClient struct {
	Replica *litestream.Replica
	// contains filtered or unexported fields
}

ReplicaClient is a client for writing LTX files to disk.

func NewReplicaClient(path string) *ReplicaClient

NewReplicaClient returns a new instance of ReplicaClient.

func (c *ReplicaClient) DeleteAll(ctx context.Context) error

DeleteAll deletes all LTX files.

func (c *ReplicaClient) DeleteLTXFiles(ctx context.Context, a []*ltx.FileInfo) error

DeleteLTXFiles deletes LTX files.

func (c *ReplicaClient) LTXFilePath(level int, minTXID, maxTXID ltx.TXID) string

LTXFilePath returns the path to an LTX file.

func (c *ReplicaClient) LTXFiles(ctx context.Context, level int, seek ltx.TXID) (ltx.FileIterator, error)

LTXFiles returns an iterator over all available LTX files.

func (c *ReplicaClient) LTXLevelDir(level int) string

LTXLevelDir returns the path to a given level.

func (c *ReplicaClient) OpenLTXFile(ctx context.Context, level int, minTXID, maxTXID ltx.TXID, offset, size int64) (io.ReadCloser, error)

OpenLTXFile returns a reader for an LTX file at the given position. Returns os.ErrNotExist if no matching index/offset is found.

func (c *ReplicaClient) Path() string

Path returns the destination path to replicate the database to.

func (c *ReplicaClient) Type() string

Type returns "file" as the client type.

func (c *ReplicaClient) WriteLTXFile(ctx context.Context, level int, minTXID, maxTXID ltx.TXID, rd io.Reader) (info *ltx.FileInfo, err error)

WriteLTXFile writes an LTX file to disk.