ltx

package module

Go to main page

Versions in this module

v0

v0.3.13

Sep 6, 2023

Changes in this version

+ type Checksum uint64

+ func ParseChecksum(s string) (Checksum, error)

+ func (c *Checksum) UnmarshalJSON(data []byte) (err error)

+ func (c Checksum) MarshalJSON() ([]byte, error)

+ func (c Checksum) String() string

v0.3.12

Aug 19, 2023

Changes in this version

+ const RFC3339Milli

+ func FormatTimestamp(t time.Time) string

+ func ParseTimestamp(value string) (time.Time, error)

v0.3.11

Aug 9, 2023

Changes in this version

type Header

+ func (h *Header) LockPgno() uint32

v0.3.10

Aug 7, 2023

Changes in this version

type Pos

+ func ParsePos(s string) (Pos, error)

v0.3.9

Aug 2, 2023

Changes in this version

type Compactor

+ AllowNonContiguousTXIDs bool

v0.3.8

Aug 1, 2023

v0.3.7

Jul 28, 2023

Changes in this version

type Header

+ func PeekHeader(r io.Reader) (Header, io.Reader, error)

v0.3.6

Jul 21, 2023

Changes in this version

type Decoder

+ func (dec *Decoder) PostApplyPos() Pos

type Encoder

+ func (enc *Encoder) PostApplyPos() Pos

type Header

+ func (h Header) PreApplyPos() Pos

v0.3.5

Jul 12, 2023

v0.3.4

Jun 21, 2023

Changes in this version

type Decoder

+ func (dec *Decoder) DecodeDatabaseTo(w io.Writer) error

v0.3.3

May 23, 2023

Changes in this version

type Compactor

+ HeaderFlags uint32

+ func (c *Compactor) Header() Header

+ func (c *Compactor) Trailer() Trailer

type Pos

+ func NewPos(txID TXID, postApplyChecksum uint64) Pos

v0.3.2

May 12, 2023

Changes in this version

+ type TXID uint64

+ func (t *TXID) UnmarshalJSON(data []byte) (err error)

+ func (t TXID) MarshalJSON() ([]byte, error)

+ func (t TXID) String() string

v0.3.1

May 3, 2023

Changes in this version

type FileSpec

+ func (s *FileSpec) GoString() string

type Header

+ NodeID uint64

type PageSpec

+ func (s *PageSpec) GoString() string

+ type Pos struct

+ PostApplyChecksum uint64

+ TXID uint64

+ func (p *Pos) UnmarshalJSON(data []byte) (err error)

+ func (p Pos) IsZero() bool

+ func (p Pos) MarshalJSON() ([]byte, error)

+ func (p Pos) String() string

+ type PosMismatchError struct

+ Pos Pos

+ func NewPosMismatchError(pos Pos) *PosMismatchError

+ func (e *PosMismatchError) Error() string

v0.3.0

Dec 28, 2022

Changes in this version

+ const HeaderFlagCompressLZ4

+ const HeaderFlagMask

type Decoder

+ func (dec *Decoder) PageN() int

type Header

+ func DecodeHeader(r io.Reader) (hdr Header, data []byte, err error)

v0.2.13

Dec 19, 2022

v0.2.12

Dec 18, 2022

v0.2.11

Dec 15, 2022

Changes in this version

+ const PENDING_BYTE

+ func LockPgno(pageSize uint32) uint32

v0.2.10

Dec 8, 2022

Changes in this version

+ func ChecksumPageWithHasher(h hash.Hash64, pgno uint32, data []byte) uint64

+ func NewHasher() hash.Hash64

v0.2.9

Nov 30, 2022

v0.2.8

Nov 29, 2022

Changes in this version

type Header

+ WALOffset int64

+ WALSalt1 uint32

+ WALSalt2 uint32

+ WALSize int64

v0.2.7

Nov 22, 2022

v0.2.6

Nov 22, 2022

Changes in this version

type Reader

+ func (r *Reader) PageN() int

v0.2.5

Nov 17, 2022

v0.2.4

Nov 17, 2022

v0.2.4-alpha4

Nov 17, 2022

v0.2.4-alpha3

Nov 17, 2022

v0.2.4-alpha2

Nov 17, 2022

v0.2.4-alpha1

Nov 17, 2022

v0.2.3

Sep 13, 2022

v0.2.2

Aug 15, 2022

Changes in this version

+ const MaxPageSize

+ var ErrDecoderClosed = errors.New("ltx decoder closed")

+ var ErrEncoderClosed = errors.New("ltx encoder closed")

+ func FormatDBID(id uint32) string

+ func ParseDBID(s string) (uint32, error)

+ func ParseTXID(s string) (uint64, error)

+ type Decoder struct

+ func NewDecoder(r io.Reader) *Decoder

+ func (dec *Decoder) Close() error

+ func (dec *Decoder) DecodeHeader() error

+ func (dec *Decoder) DecodePage(hdr *PageHeader, data []byte) error

+ func (dec *Decoder) Header() Header

+ func (dec *Decoder) N() int64

+ func (dec *Decoder) Trailer() Trailer

+ func (dec *Decoder) Verify() (Header, Trailer, error)

+ type Encoder struct

+ func NewEncoder(w io.Writer) *Encoder

+ func (enc *Encoder) Close() error

+ func (enc *Encoder) EncodeHeader(hdr Header) error

+ func (enc *Encoder) EncodePage(hdr PageHeader, data []byte) (err error)

+ func (enc *Encoder) Header() Header

+ func (enc *Encoder) N() int64

+ func (enc *Encoder) SetPostApplyChecksum(chksum uint64)

+ func (enc *Encoder) Trailer() Trailer

type Reader

+ func (r *Reader) PeekHeader() error

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

+ func (r *Reader) WriteTo(dst io.Writer) (written int64, err error)

v0.2.1

Aug 12, 2022

Changes in this version

+ func ChecksumReader(r io.Reader, pageSize int) (uint64, error)

v0.2.0

Aug 10, 2022

Changes in this version

+ const TrailerChecksumOffset

+ const TrailerSize

+ var ErrChecksumMismatch = errors.New("file checksum mismatch")

+ var ErrInvalidChecksumFormat = errors.New("invalid file checksum format")

+ var ErrNoChecksum = errors.New("no file checksum")

type FileSpec

+ Pages []PageSpec

+ Trailer Trailer

type Header

+ PreApplyChecksum uint64

type PageHeader

+ func (h *PageHeader) IsZero() bool

+ type PageSpec struct

+ Data []byte

+ Header PageHeader

+ type Reader struct

+ func NewReader(r io.Reader) *Reader

+ func (r *Reader) Checksum() uint64

+ func (r *Reader) Close() error

+ func (r *Reader) Header() Header

+ func (r *Reader) N() int64

+ func (r *Reader) ReadHeader() error

+ func (r *Reader) ReadPage(hdr *PageHeader, data []byte) error

+ func (r *Reader) Trailer() Trailer

+ func (r *Reader) Verify() (Header, Trailer, error)

+ type Trailer struct

+ FileChecksum uint64

+ PostApplyChecksum uint64

+ func (t *Trailer) MarshalBinary() ([]byte, error)

+ func (t *Trailer) UnmarshalBinary(b []byte) error

+ func (t *Trailer) Validate() error

+ type Writer struct

+ func NewWriter(w io.Writer) *Writer

+ func (w *Writer) Close() error

+ func (w *Writer) Header() Header

+ func (w *Writer) N() int64

+ func (w *Writer) SetPostApplyChecksum(chksum uint64)

+ func (w *Writer) Trailer() Trailer

+ func (w *Writer) WriteHeader(hdr Header) error

+ func (w *Writer) WritePage(hdr PageHeader, data []byte) (err error)

v0.1.0

Jul 1, 2022

Changes in this version

+ const ChecksumFlag

+ const ChecksumMask

+ const ChecksumSize

+ const EventHeaderSize

+ const HeaderBlockChecksumOffset

+ const HeaderChecksumOffset

+ const HeaderSize

+ const Magic

+ const PageBlockChecksumOffset

+ const PageHeaderSize

+ const Version

+ var ErrHeaderBlockChecksumMismatch = errors.New("header block checksum mismatch")

+ var ErrHeaderChecksumMismatch = errors.New("header checksum mismatch")

+ var ErrInvalidFile = errors.New("invalid LTX file")

+ var ErrInvalidHeaderChecksumFormat = errors.New("invalid header checksum format")

+ var ErrNoHeaderChecksum = errors.New("no header checksum")

+ var ErrPageBlockChecksumMismatch = errors.New("header page checksum mismatch")

+ var ErrReaderClosed = errors.New("reader closed")

+ var ErrWriterClosed = errors.New("writer closed")

+ func ChecksumPage(pgno uint32, data []byte) uint64

+ func FormatFilename(minTXID, maxTXID uint64) string

+ func FormatTXID(id uint64) string

+ func FormatTXIDRange(min, max uint64) string

+ func IsValidHeaderFlags(flags uint32) bool

+ func IsValidPageSize(sz uint32) bool

+ func PageAlign(v int64, pageSize uint32) int64

+ func ParseFilename(name string) (minTXID, maxTXID uint64, err error)

+ func UniquePageN(filenames []string) (pageN uint32, err error)

+ type Compactor struct

+ IncludeEvents bool

+ Sync bool

+ func NewCompactor() *Compactor

+ func (c *Compactor) Compact(outputFilename string, inputFilenames []string) (retErr error)

+ type EventHeader struct

+ Nonce [12]byte

+ Size uint32

+ Tag [16]byte

+ func (h *EventHeader) MarshalBinary() ([]byte, error)

+ func (h *EventHeader) UnmarshalBinary(b []byte) error

+ func (h *EventHeader) Validate() error

+ type FileSpec struct

+ EventData [][]byte

+ EventHeaders []EventHeader

+ Header Header

+ PageData [][]byte

+ PageHeaders []PageHeader

+ func (s *FileSpec) Bytes() ([]byte, error)

+ func (s *FileSpec) MustBytes() []byte

+ func (s *FileSpec) ReadFrom(r io.Reader) (n int, err error)

+ func (s *FileSpec) WriteTo(w io.Writer) (n int64, err error)

+ type Header struct

+ Commit uint32

+ DBID uint32

+ EventDataSize uint32

+ EventN uint32

+ Flags uint32

+ HeaderBlockChecksum uint64

+ HeaderChecksum uint64

+ MaxTXID uint64

+ MinTXID uint64

+ PageBlockChecksum uint64

+ PageN uint32

+ PageSize uint32

+ PostChecksum uint64

+ PreChecksum uint64

+ Timestamp uint64

+ Version int

+ func (h *Header) HeaderBlockSize() int64

+ func (h *Header) IsSnapshot() bool

+ func (h *Header) MarshalBinary() ([]byte, error)

+ func (h *Header) Prevalidate() error

+ func (h *Header) UnmarshalBinary(b []byte) error

+ func (h *Header) Validate() error

+ type HeaderBlockReader struct

+ func NewHeaderBlockReader(r io.Reader) *HeaderBlockReader

+ func (r *HeaderBlockReader) Checksum() uint64

+ func (r *HeaderBlockReader) Close() error

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

+ func (r *HeaderBlockReader) ReadEventHeader(hdr *EventHeader) error

+ func (r *HeaderBlockReader) ReadHeader(hdr *Header) error

+ func (r *HeaderBlockReader) ReadPageHeader(hdr *PageHeader) error

+ type HeaderBlockWriter struct

+ func NewHeaderBlockWriter(w io.WriteSeeker) *HeaderBlockWriter

+ func (w *HeaderBlockWriter) Close() error

+ func (w *HeaderBlockWriter) Header() Header

+ func (w *HeaderBlockWriter) SetPageBlockChecksum(chksum uint64)

+ func (w *HeaderBlockWriter) SetPostChecksum(chksum uint64)

+ func (w *HeaderBlockWriter) Write(p []byte) (n int, err error)

+ func (w *HeaderBlockWriter) WriteEventHeader(hdr EventHeader) (err error)

+ func (w *HeaderBlockWriter) WriteHeader(hdr Header) error

+ func (w *HeaderBlockWriter) WritePageHeader(hdr PageHeader) (err error)

+ type PageBlockReader struct

+ func NewPageBlockReader(r io.Reader, pageN, pageSize uint32, checksum uint64) *PageBlockReader

+ func (r *PageBlockReader) Checksum() uint64

+ func (r *PageBlockReader) Close() error

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

+ func (r *PageBlockReader) Remaining() int64

+ func (r *PageBlockReader) Size() int64

+ type PageBlockWriter struct

+ func NewPageBlockWriter(w io.Writer, pageN, pageSize uint32) *PageBlockWriter

+ func (w *PageBlockWriter) Checksum() uint64

+ func (w *PageBlockWriter) Close() error

+ func (w *PageBlockWriter) Remaining() int64

+ func (w *PageBlockWriter) Size() int64

+ func (w *PageBlockWriter) Write(p []byte) (n int, err error)

+ type PageHeader struct

+ Nonce [12]byte

+ Pgno uint32

+ Tag [16]byte

+ func (h *PageHeader) MarshalBinary() ([]byte, error)

+ func (h *PageHeader) UnmarshalBinary(b []byte) error

+ func (h *PageHeader) Validate() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL