xtdb-core/xtdb.api.log/LocalLog

LocalLog

class LocalLog<M> @JvmOverloads constructor(rootPath: Path, codec: MessageCodec<M>, instantSource: InstantSource, val epoch: Int, val useInstantSourceForNonTx: Boolean, coroutineContext: CoroutineContext = Dispatchers.IO, baseFileName: String = "LOG", val partitions: Int = 1) : Log<M>

Constructors

LocalLog

@JvmOverloads

constructor(rootPath: Path, codec: MessageCodec<M>, instantSource: InstantSource, epoch: Int, useInstantSourceForNonTx: Boolean, coroutineContext: CoroutineContext = Dispatchers.IO, baseFileName: String = "LOG", partitions: Int = 1)

Types

Companion

object Companion

Factory

@SerialName(value = "!Local")

@Serializable

data class Factory @JvmOverloads constructor(val path: Path, var instantSource: InstantSource = InstantSource.system(), var epoch: Int = 0, var useInstantSourceForNonTx: Boolean = false, var coroutineContext: CoroutineContext = Dispatchers.IO) : Log.Factory

Used to set configuration options for a local directory based XTDB Log.

Properties

epoch

open override val epoch: Int

partitions

val partitions: Int

useInstantSourceForNonTx

val useInstantSourceForNonTx: Boolean

Functions

appendMessage

open suspend fun appendMessage(message: M, partition: Int = 0): Log.MessageMetadata

appendMessageBlocking

open fun appendMessageBlocking(message: M, partition: Int = 0): Log.MessageMetadata

open override fun close()

enqueueMessage

open suspend override fun enqueueMessage(message: M, partition: Int = 0): Deferred<Log.MessageMetadata>

Appends message, returning once its place in this partition's order is fixed - the Deferred completes with its offset once it is durable.

latestSubmittedMsgId

open fun latestSubmittedMsgId(partition: Int = 0): MessageId

latestSubmittedOffset

open override fun latestSubmittedOffset(partition: Int = 0): LogOffset

readLastMessage

open override fun readLastMessage(partition: Int = 0): M?

readRecords

open override fun readRecords(partition: Int, fromMsgId: MessageId, toMsgId: MessageId): Sequence<Log.Record<M>>

Reads records in the range [fromMsgId, toMsgId) (start-inclusive, end-exclusive). Returns a lazy sequence of decoded records in offset order. If toMsgId exceeds the latest submitted offset, reads up to the latest available record.

tailAll

open suspend fun tailAll(partition: Int, afterMsgId: MessageId, pollTimeout: Duration = 1.seconds, processor: Log.RecordProcessor<M>)

Polls a tail until cancelled, handing every poll to processor, including empty polls.

withTail

open suspend override fun <R> withTail(partition: Int, afterMsgId: MessageId, action: suspend (Log.Tail<M>) -> R): R

Runs action with a tail positioned after afterMsgId. The tail and its subscription are valid only until action returns.