xtdb-core/xtdb.api.tx/OpenTx

OpenTx

class OpenTx @JvmOverloads constructor(allocator: BufferAllocator, nodeBase: NodeBase, dbStorage: DatabaseStorage, dbState: DatabaseState, 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.

Stage writes per table via table; openQuery / executeSql run SQL against the live index with read-your-writes visibility into those staged writes. TxIndexer owns opening, committing and closing the OpenTx — a writer is handed one, it never constructs its own.

Constructors

OpenTx

@JvmOverloads

constructor(allocator: BufferAllocator, nodeBase: NodeBase, dbStorage: DatabaseStorage, dbState: DatabaseState, txKey: TransactionKey, externalSourceToken: ExternalSourceToken?, tracer: Tracer? = null, resolvedTxs: List<ResolvedTx> = emptyList())

Types

Companion

object Companion

QueryOpts

data class QueryOpts(val currentTime: Instant? = null, val defaultTz: ZoneId? = null)

Table

inner class Table : AutoCloseable

Per-table staging area for a tx's writes.

Properties

externalSourceToken

val externalSourceToken: ExternalSourceToken?

systemTime

val systemTime: Instant

systemTimeMicros

val systemTimeMicros: Long

txKey

val txKey: TransactionKey

Functions

open override fun close()

executeSql

@JvmOverloads

fun executeSql(sql: String, args: RelationReader? = null, opts: OpenTx.QueryOpts = QueryOpts(), user: String? = null)

Execute a DML/DDL SQL statement against this tx, with visibility into writes made earlier in the same writer call. Positional ? parameters come from args, like openQuery.

openQuery

fun openQuery(sql: String, args: RelationReader? = null, opts: OpenTx.QueryOpts = QueryOpts()): ResultCursor

Run SQL against the database's live index, with visibility into writes made earlier in this transaction.

table

@JvmOverloads

fun table(schemaName: SchemaName = DEFAULT_SCHEMA, tableName: TableName): OpenTx.Table

The staging area for writes to table in this tx, created on first access.