xtdb-core/xtdb.api/Xtdb/Connection

Connection

class Connection(val allocator: BufferAllocator, dbCat: Database.Catalog, qSrc: IQuerySource, sqlPlanner: SqlPlanner, var dbName: DatabaseName, var clock: InstantSource, var defaultTz: ZoneId, tracer: Tracer?, metrics: ConnectionMetrics?) : AdbcConnection

Constructors

Connection

constructor(allocator: BufferAllocator, dbCat: Database.Catalog, qSrc: IQuerySource, sqlPlanner: SqlPlanner, dbName: DatabaseName, clock: InstantSource, defaultTz: ZoneId, tracer: Tracer?, metrics: ConnectionMetrics?)

Types

LastSubmittedTx

data class LastSubmittedTx(val txId: MessageId, val systemTime: Instant?, val committed: Boolean?, val error: Throwable?)

Properties

allocator

val allocator: BufferAllocator

autoCommit

open var autoCommit: Boolean

awaitToken

var awaitToken: String?

clock

var clock: InstantSource

currentCatalog

open override var currentCatalog: String

currentDbSchema

open override var currentDbSchema: String

dbName

var dbName: DatabaseName

defaultTz

var defaultTz: ZoneId

info

open val info: ArrowReader?

isolationLevel

open var isolationLevel: IsolationLevel?

lastSubmittedTx

var lastSubmittedTx: Xtdb.Connection.LastSubmittedTx?

readOnly

open var readOnly: Boolean

sessionParameters

val sessionParameters: Map<String, String?>

statisticNames

open val statisticNames: ArrowReader?

tableTypes

open override val tableTypes: ArrowReader

user

var user: String?

Functions

attachDb

fun attachDb(dbName: DatabaseName, config: Database.Config): Xtdb.ExecutedTx

begin

fun begin()

beginReadOnly

@JvmOverloads

fun beginReadOnly(tz: ZoneId = defaultTz, snapshotToken: String? = null, snapshotTime: Instant? = null, currentTime: Instant? = null)

beginWriteOnly

@JvmOverloads

fun beginWriteOnly(systemTime: Instant? = null, userMetadata: Map<*, *>? = null, async: Boolean = false, tz: ZoneId = defaultTz)

bulkIngest

open override fun bulkIngest(targetTableName: String, mode: BulkIngestMode): Xtdb.Statement

cancel

open fun cancel()

open override fun close()

commit

open override fun commit()

commitAsync

fun commitAsync(): Xtdb.SubmittedTx?

commitSync

fun commitSync(): Xtdb.ExecutedTx?

createStatement

open override fun createStatement(): Xtdb.Statement

fun createStatement(sql: String): Xtdb.Statement

detachDb

fun detachDb(dbName: DatabaseName): Xtdb.ExecutedTx

executeTx

fun executeTx(ops: List<TxOp>, opts: TxOpts = TxOpts()): Xtdb.ExecutedTx

executeTxOp

fun executeTxOp(op: TxOp)

getCurrentCatalog

open override fun getCurrentCatalog(): String

getCurrentDbSchema

open override fun getCurrentDbSchema(): String

getInfo

open override fun getInfo(infoCodes: IntArray?): ArrowReader

getObjects

open override fun getObjects(depth: AdbcConnection.GetObjectsDepth, catalogPattern: String?, dbSchemaPattern: String?, tableNamePattern: String?, tableTypes: Array<out String>?, columnNamePattern: String?): ArrowReader

getOption