commitlog

package

Go to main page

Versions in this module

v0

v0.6.1

Jul 1, 2026

Changes in this version

+ func EncodeRawKVBatchPayloadPlanned(plan RawKVBatchPayloadPlan, scan RawKVBatchOperationScanner) ([]byte, error)

+ func ScanRawKVBatchPayloadWithRevision(payload []byte, ...) error

type CommandJournal

+ func (j *CommandJournal) AppendRawKVPointCommandTrustedWithRevisionAndFlush(baseAppliedLSN uint64, op RawKVOp, key, value []byte, revision uint64, ...) (uint64, error)

type RawKVBatchPayloadBuilder

+ func (b *RawKVBatchPayloadBuilder) EnableEntryRevisions() error

+ func (b *RawKVBatchPayloadBuilder) EntryRevisionsEnabled() bool

+ func (b *RawKVBatchPayloadBuilder) RevisionSlotOffsets() []uint32

+ func (b *RawKVBatchPayloadBuilder) StampEntryRevisions(scan func(func(uint64) error) error) error

type RawKVBatchPayloadPlan

+ EntryRevisions bool

type RawKVOperation

+ Revision uint64

type Record

+ Revision uint64

v0.6.0

Jul 1, 2026

Changes in this version

+ const CommandFrameVersion

+ const CommandWALNonCriticalFlagStart

+ const MaxCommandJournalLane

+ const OpSetInlineZero

+ var ErrCommandWALDuplicateLSN = errors.New("commitlog: command wal duplicate lsn")

+ var ErrCommandWALLegacyPayload = errors.New("commitlog: legacy raw payload in command wal")

+ var ErrCommandWALSegmentSeqExhausted = errors.New("commitlog: command wal segment sequence exhausted")

+ var ErrCommandWALStaleSegment = errors.New("commitlog: command wal stale segment")

+ var ErrCommandWALTerminalTail = errors.New("commitlog: command wal terminal incomplete tail")

+ var ErrCommandWALUnsupportedCriticalFlag = errors.New("commitlog: command wal unsupported critical flag")

+ var ErrCommandWALUnsupportedKind = errors.New("commitlog: command wal unsupported kind")

+ var ErrCommandWALUnsupportedVersion = errors.New("commitlog: command wal unsupported version")

+ var ErrJournalOwnerExists = errors.New("commitlog: journal owner already exists")

+ func CommandSegmentName(lane int, seq uint64) string

+ func EncodeCatalogCreateCollectionPayload(collection string, metadata []byte) ([]byte, error)

+ func EncodeCollectionDeleteBatchByIDPayload(collection string, ids [][]byte) ([]byte, error)

+ func EncodeCollectionInsertBatchByIDPayload(collection string, docs []CollectionDocument) ([]byte, error)

+ func EncodeCollectionRebuildVectorIndexPayload(collection, indexName string) ([]byte, error)

+ func EncodeCollectionUpdateBatchByIDPayload(collection string, docs []CollectionDocument) ([]byte, error)

+ func EncodeCommandFrame(env CommandEnvelope) ([]byte, error)

+ func EncodeRawKVBatchPayload(ops []RawKVOperation) ([]byte, error)

+ func EncodeRawKVBatchPayloadScan(scan func(func(RawKVOperation) error) error) ([]byte, error)

+ func EncodeRawKVBatchPayloadScanWithHint(scan func(func(RawKVOperation) error) error, opHint, byteHint int) ([]byte, error)

+ func EncodeRawKVSingleOperationPayload(op RawKVOperation) ([]byte, error)

+ func IsCommandSegmentName(name string) bool

+ func ScanRawKVBatchPayload(payload []byte, visit func(op RawKVOp, key, value []byte) error) error

+ type CatalogCreateCollectionPayload struct

+ Collection string

+ Metadata []byte

+ func DecodeCatalogCreateCollectionPayload(payload []byte) (CatalogCreateCollectionPayload, error)

+ type CollectionDeleteBatchByIDPayload struct

+ Collection string

+ IDs [][]byte

+ func DecodeCollectionDeleteBatchByIDPayload(payload []byte) (CollectionDeleteBatchByIDPayload, error)

+ type CollectionDocument struct

+ Document []byte

+ ID []byte

+ type CollectionInsertBatchByIDPayload struct

+ Collection string

+ Documents []CollectionDocument

+ func DecodeCollectionInsertBatchByIDPayload(payload []byte) (CollectionInsertBatchByIDPayload, error)

+ type CollectionRebuildVectorIndexPayload struct

+ Collection string

+ IndexName string

+ func DecodeCollectionRebuildVectorIndexPayload(payload []byte) (CollectionRebuildVectorIndexPayload, error)

+ type CollectionUpdateBatchByIDPayload struct

+ Collection string

+ Documents []CollectionDocument

+ func DecodeCollectionUpdateBatchByIDPayload(payload []byte) (CollectionUpdateBatchByIDPayload, error)

+ type CommandEnvelope struct

+ BaseAppliedLSN uint64

+ CatalogEpoch uint64

+ ExternalRefs []ExternalRef

+ FeatureFlags uint64

+ Kind CommandKind

+ LSN uint64

+ Payload []byte

+ PayloadFormat PayloadFormat

+ Preconditions []CommandExtension

+ ResultAssertions []CommandExtension

+ SchemaEpoch uint64

+ Scope CommandScope

+ Version uint16

+ func DecodeCommandFrame(frame []byte) (CommandEnvelope, error)

+ func ScanCommandFrameSegments(paths []string, opts Options) ([]CommandEnvelope, error)

+ func ScanCommandFrames(path string, opts Options) ([]CommandEnvelope, error)

+ type CommandExtension struct

+ Payload []byte

+ Type uint16

+ type CommandJournal struct

+ func OpenCommandJournal(walDir string, opts CommandJournalOptions) (*CommandJournal, error)

+ func (j *CommandJournal) ActiveBytes() int64

+ func (j *CommandJournal) ActiveSegmentSnapshot() (path string, bytes int64)

+ func (j *CommandJournal) AppendCommand(env CommandEnvelope) (uint64, error)

+ func (j *CommandJournal) AppendCommandPayloadTrusted(kind CommandKind, scope CommandScope, format PayloadFormat, ...) (uint64, error)

+ func (j *CommandJournal) AppendRawKVBatchPayloadCommand(baseAppliedLSN uint64, payload []byte) (uint64, error)

+ func (j *CommandJournal) AppendRawKVBatchPayloadCommandTrusted(baseAppliedLSN uint64, payload []byte) (uint64, error)

+ func (j *CommandJournal) AppendRawKVBatchPayloadCommandTrustedAndFlush(baseAppliedLSN uint64, payload []byte, sync bool) (uint64, error)

+ func (j *CommandJournal) AppendRawKVBatchPayloadScanCommandTrusted(baseAppliedLSN uint64, plan RawKVBatchPayloadPlan, ...) (uint64, error)

+ func (j *CommandJournal) AppendRawKVBatchPayloadScanCommandTrustedAndFlush(baseAppliedLSN uint64, plan RawKVBatchPayloadPlan, ...) (uint64, error)

+ func (j *CommandJournal) AppendRawKVPointCommandTrusted(baseAppliedLSN uint64, op RawKVOp, key, value []byte) (uint64, error)

+ func (j *CommandJournal) AppendRawKVPointCommandTrustedAndFlush(baseAppliedLSN uint64, op RawKVOp, key, value []byte, sync bool) (uint64, error)

+ func (j *CommandJournal) AppendRawKVSingleCommand(baseAppliedLSN uint64, op RawKVOperation) (uint64, error)

+ func (j *CommandJournal) AppendRawKVSingleCommandAndFlush(baseAppliedLSN uint64, op RawKVOperation, sync bool) (uint64, error)

+ func (j *CommandJournal) Close() error

+ func (j *CommandJournal) Flush() error

+ func (j *CommandJournal) NextLSN() uint64

+ func (j *CommandJournal) Path() string

+ func (j *CommandJournal) RotateActiveSegment(syncCurrent bool) error

+ func (j *CommandJournal) Sync() error

+ func (j *CommandJournal) WriterBufferStats() WriterBufferStats

+ type CommandJournalOptions struct

+ BufferSize int

+ Compress bool

+ DeferredCommandBufferRetainSize int

+ DeferredCommandBufferSize int

+ InitialLSN uint64

+ Lane int

+ MaxSegmentSize int64

+ OnSegmentRotated func(closedBytes int64)

+ SegmentSeq uint64

+ SegmentTargetBytes int64

+ type CommandKind uint16

+ const CommandKindCatalogCreateCollection

+ const CommandKindCatalogMutationPlaceholder

+ const CommandKindCollectionDeleteBatchByID

+ const CommandKindCollectionInsertBatchByID

+ const CommandKindCollectionRebuildVectorIndex

+ const CommandKindCollectionUpdateBatchByID

+ const CommandKindRawKVBatch

+ type CommandScope uint16

+ const CommandScopeCatalog

+ const CommandScopeCollection

+ const CommandScopeRawKV

+ type ExternalRef struct

+ Class ExternalRefClass

+ Digest [32]byte

+ FileID uint64

+ Flags uint16

+ Length uint64

+ Offset uint64

+ Path []byte

+ type ExternalRefClass uint16

+ const ExternalRefLeafLog

+ const ExternalRefPayloadFile

+ const ExternalRefValueLog

+ type JournalOwner struct

+ func AcquireJournalOwner(dir string) (*JournalOwner, error)

+ func AcquireJournalOwnerWithOptions(dir string, opts JournalOwnerOptions) (*JournalOwner, error)

+ func (o *JournalOwner) Close() error

+ type JournalOwnerOptions struct

+ InitialLSN uint64

type Options

+ BufferSize int

+ DeferredCommandBufferRetainSize int

+ DeferredCommandBufferSize int

+ type PayloadFormat uint16

+ const PayloadFormatCatalogCreateCollectionV1

+ const PayloadFormatCollectionDeleteBatchByIDV1

+ const PayloadFormatCollectionInsertBatchByIDV1

+ const PayloadFormatCollectionRebuildVectorIndexV1

+ const PayloadFormatCollectionUpdateBatchByIDV1

+ const PayloadFormatNativeWireDeterministic

+ const PayloadFormatRawKVBatchV1

+ type RawKVBatchOperationScanner func(func(RawKVOperation) error) error

+ type RawKVBatchPayloadBuilder struct

+ func NewRawKVBatchPayloadBuilder(opHint, byteHint int) RawKVBatchPayloadBuilder

+ func (b *RawKVBatchPayloadBuilder) Append(op RawKVOperation) (keyView, valueView []byte, err error)

+ func (b *RawKVBatchPayloadBuilder) AppendDelete(key []byte) (keyView []byte, err error)

+ func (b *RawKVBatchPayloadBuilder) AppendDeleteRange(start, end []byte) (startView []byte, err error)

+ func (b *RawKVBatchPayloadBuilder) AppendSet(key, value []byte) (keyView, valueView []byte, err error)

+ func (b *RawKVBatchPayloadBuilder) Count() int

+ func (b *RawKVBatchPayloadBuilder) Len() int

+ func (b *RawKVBatchPayloadBuilder) Payload() []byte

+ func (b *RawKVBatchPayloadBuilder) ResetWithHint(opHint, byteHint int) error

+ func (b *RawKVBatchPayloadBuilder) RetainedCap() int

+ func (b *RawKVBatchPayloadBuilder) RetainedCapAfterAppend(needed int) (int, error)

+ func (b *RawKVBatchPayloadBuilder) RetainedCapAfterAppendDelete(key []byte) (int, error)

+ func (b *RawKVBatchPayloadBuilder) RetainedCapAfterAppendDeleteRange(start, end []byte) (int, error)

+ func (b *RawKVBatchPayloadBuilder) RetainedCapAfterAppendSet(key, value []byte) (int, error)

+ func (b *RawKVBatchPayloadBuilder) Truncate(payloadLen, count int)

+ type RawKVBatchPayloadPlan struct

+ Count int

+ PayloadLen int

+ func PlanRawKVBatchPayloadScan(scan RawKVBatchOperationScanner) (RawKVBatchPayloadPlan, error)

+ type RawKVOp byte

+ const RawKVOpDelete

+ const RawKVOpDeleteRange

+ const RawKVOpSet

+ const RawKVOpSetRID

+ type RawKVOperation struct

+ Key []byte

+ Op RawKVOp

+ RID uint64

+ Value []byte

+ func DecodeRawKVBatchPayload(payload []byte) ([]RawKVOperation, error)

type Reader

+ func (r *Reader) ReadCommandFrame() (CommandEnvelope, error)

type Writer

+ func (w *Writer) ActiveBytes() int64

+ func (w *Writer) AppendCommand(env CommandEnvelope) error

+ func (w *Writer) AppendCommandPayloadDirectTrusted(lsn, baseAppliedLSN uint64, kind CommandKind, scope CommandScope, ...) error

+ func (w *Writer) AppendRawKVBatchPayloadCommandDirect(lsn, baseAppliedLSN uint64, payload []byte) error

+ func (w *Writer) AppendRawKVBatchPayloadCommandDirectTrusted(lsn, baseAppliedLSN uint64, payload []byte) error

+ func (w *Writer) AppendRawKVBatchPayloadScanCommandDirectTrusted(lsn, baseAppliedLSN uint64, plan RawKVBatchPayloadPlan, ...) error

+ func (w *Writer) AppendRawKVPointCommandDirectTrusted(lsn, baseAppliedLSN uint64, op RawKVOp, key, value []byte) error

+ func (w *Writer) AppendRawKVSingleCommandDirect(lsn, baseAppliedLSN uint64, op RawKVOperation) error

+ func (w *Writer) AppendZeroInlineBatchFunc(count int, seq uint64, valueLen int, keyAt func(int) []byte) error

+ func (w *Writer) BufferStats() WriterBufferStats

+ func (w *Writer) RotateToWithSync(path string, syncCurrent bool) error

+ type WriterBufferStats struct

+ BufferedWriterBufferedBytes int

+ BufferedWriterSize int

+ CommandBufferCapacity int

+ CommandBufferDroppedBytes uint64

+ CommandBufferLength int

+ CommandBufferLimit int

+ CommandBufferRetainLimit int

+ CommandBufferTrimCount uint64

+ PendingBatchCapacity int

+ PendingBatchLength int

+ ScratchCapacity int

v0.5.0

Apr 17, 2026

v0.4.0

Apr 3, 2026

Changes in this version

+ var ErrMixedBatchSeq = errors.New("commitlog: mixed batch sequence")

v0.3.0

Feb 7, 2026

v0.2.0

Jan 24, 2026

Changes in this version

+ const OpDelete

+ const OpSetInline

+ const OpSetRID

+ const Version

+ var ErrCorrupt = errors.New("commitlog: corrupt record")

+ var ErrRecordTooLarge = errors.New("commitlog: record too large")

+ type Options struct

+ Compress bool

+ MaxSegmentSize int64

+ type Reader struct

+ func NewReader(path string) (*Reader, error)

+ func NewReaderWithOptions(path string, opts Options) (*Reader, error)

+ func (r *Reader) Close() error

+ func (r *Reader) ReadBatch() ([]Record, error)

+ type Record struct

+ Key []byte

+ Op byte

+ RID uint64

+ Seq uint64

+ Value []byte

+ type Writer struct

+ func NewWriter(path string) (*Writer, error)

+ func NewWriterWithOptions(path string, opts Options) (*Writer, error)

+ func (w *Writer) Append(record Record) error

+ func (w *Writer) AppendBatch(records []Record) error

+ func (w *Writer) Close() error

+ func (w *Writer) Flush() error

+ func (w *Writer) RotateTo(path string) error

+ func (w *Writer) Size() int64

+ func (w *Writer) Sync() error

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