xtdb-core/xtdb.api.tx

Package-level declarations

Types

data class BlockDetails(val blockIndex: BlockIndex, val latestCompletedTx: TransactionKey?, val latestProcessedMsgId: MessageId?, val boundaryReplicaMsgId: MessageId?, val termId: Long, val externalSourceToken: ExternalSourceToken?, val tableNames: List<TableRef>, val secondaryDatabases: Map<String, DatabaseConfig>)

What a block persisted to object storage carries.

ExternalSource

interface ExternalSource : AutoCloseable

SPI for streaming transactions into a database from an upstream feed (a CDC source, message log, etc.) instead of XTDB's own DML.

ExternalSourceToken

typealias ExternalSourceToken = ByteArray

Opaque resume marker (e.g. a serialised log offset) that XTDB persists per tx and hands back on resume.

OpenTx

class OpenTx @JvmOverloads constructor(allocator: BufferAllocator, nodeBase: NodeBase, partitionStorage: PartitionStorage, partitionState: PartitionState, dbName: DatabaseName, val txKey: TransactionKey, val externalSourceToken: ExternalSourceToken?, tracer: Tracer? = null, resolvedTxs: List<ResolvedTx> = emptyList()) : AutoCloseable

The per-transaction write/read handle passed to an external-source writer.

TxIndexer

interface TxIndexer

Per-tx entry point for external sources. The source provides tx metadata + a writer that populates the OpenTx and returns a TxResult indicating success or failure (with optional userMetadata — the source can decide metadata after writing, not before).