xtdb-core/xtdb.api.log/LocalLog/Factory

Factory

@SerialName(value = "!Local")

@Serializable

data class Factory @JvmOverloads constructor(val path: Path, var instantSource: InstantSource = InstantSource.system(), var epoch: Int = 0, var termEpoch: 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.

Example usage, as part of a node config:

Xtdb.openNode {
   log = localLog(Path("test-path")) {
     instantSource = InstantSource.system()
     bufferSize = 4096
     pollSleepDuration = Duration.ofMillis(100)
   }
   ...
}

Constructors

Factory

@JvmOverloads

constructor(path: Path, instantSource: InstantSource = InstantSource.system(), epoch: Int = 0, termEpoch: Int = 0, useInstantSourceForNonTx: Boolean = false, coroutineContext: CoroutineContext = Dispatchers.IO)

Properties

coroutineContext

@Transient

var coroutineContext: CoroutineContext

epoch

var epoch: Int

instantSource

@Transient

var instantSource: InstantSource

path

val path: Path

termEpoch

var termEpoch: Int

Declares that the leader-election counter behind this log has been reset, so that terms from before the reset still order below terms from after it. Bump it — never lower it — whenever that happens; a node that finds its own term already fenced on the replica log refuses to lead and names this setting. See LeaderTerm.

useInstantSourceForNonTx

var useInstantSourceForNonTx: Boolean

Functions

coroutineContext

fun coroutineContext(coroutineContext: CoroutineContext): LocalLog.Factory

epoch

fun epoch(epoch: Int): LocalLog.Factory

instantSource

fun instantSource(instantSource: InstantSource): LocalLog.Factory

openReadOnlyReplicaLog

open override fun openReadOnlyReplicaLog(remotes: Map<RemoteAlias, Remote>, partitions: Int = 1): ReadOnlyLocalLog<ReplicaMessage>

openReadOnlySourceLog

open override fun openReadOnlySourceLog(remotes: Map<RemoteAlias, Remote>, partitions: Int = 1): ReadOnlyLocalLog<SourceMessage>

openReplicaLog

open override fun openReplicaLog(remotes: Map<RemoteAlias, Remote>, partitions: Int = 1): LocalLog<ReplicaMessage>

openSourceLog

open override fun openSourceLog(remotes: Map<RemoteAlias, Remote>, partitions: Int = 1): LocalLog<SourceMessage>

termEpoch

fun termEpoch(termEpoch: Int): LocalLog.Factory

useInstantSourceForNonTx

fun useInstantSourceForNonTx(): LocalLog.Factory

writeTo

open override fun writeTo(dbConfig: DatabaseConfig.Builder)