xtdb-core/xtdb.api/Xtdb

Xtdb

interface Xtdb : DataSource, AdbcDatabase, AutoCloseable

Types

interface CompactorNode : AutoCloseable

object Companion

@Serializable

data class Config(var server: ServerConfig? = ServerConfig(), var flightSql: FlightSqlConfig? = FlightSqlConfig(), var logClusters: Map<RemoteAlias, Remote.Factory<*>> = emptyMap(), var remotes: Map<RemoteAlias, Remote.Factory<*>> = emptyMap(), var log: Log.Factory = Log.inMemoryLog, var storage: Storage.Factory = Storage.inMemory(), val memoryCache: MemoryCache.Factory = MemoryCache.Factory(), var diskCache: DiskCache.Factory? = null, var healthz: HealthzConfig? = null, var defaultTz: ZoneId = ZoneOffset.UTC, val indexer: IndexerConfig = IndexerConfig(), val compactor: CompactorConfig = CompactorConfig(), var authn: Authenticator.Factory = SingleRootUser(), var garbageCollector: GarbageCollectorConfig = GarbageCollectorConfig(), var tracer: TracerConfig = TracerConfig(), var readOnlyDatabases: Boolean = false, var skipDbs: Set<String> = System.getenv("XTDB_SKIP_DBS")?.let(::parseSkipDbsEnv).orEmpty(), var nodeId: String = System.getenv("XTDB_NODE_ID") ?: randomUUID().toString().takeWhile { it != '-' })

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

A connection to one database, dbName.

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

interface Statement : AdbcStatement

A statement on a Connection.

data class SubmittedTx(val txId: MessageId)

Properties

abstract val allocator: BufferAllocator

abstract var awaitToken: String

open val connection: Connection

abstract val databaseNames: Collection<DatabaseName>

The names of the databases this node currently serves.

abstract val flightSqlPort: Int

abstract val healthzPort: Int

The port the healthz server bound to, or -1 if healthz isn't configured on this node.

open var loginTimeout: Int

open var logWriter: PrintWriter?

open val parentLogger: Logger

abstract val serverPort: Int

serverReadOnlyPort

abstract val serverReadOnlyPort: Int

Functions

addMeterRegistry

abstract fun addMeterRegistry(meterRegistry: MeterRegistry)

abstract fun close()

abstract override fun connect(): Xtdb.Connection

abstract fun connect(dbName: DatabaseName): Xtdb.Connection

Opens an in-process connection to the named database.

createConnectionBuilder

abstract override fun createConnectionBuilder(): DataSource.ConnectionBuilder

createShardingKeyBuilder

open fun createShardingKeyBuilder(): ShardingKeyBuilder?

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

The transaction goes to TxOpts.dbName, defaulting to the primary database xtdb, and may only refer to tables within it — see Connection.

open override fun getConnection(): Connection

open override fun getConnection(username: String?, password: String?): Connection

getLoginTimeout

open override fun getLoginTimeout(): Int

open override fun getLogWriter(): PrintWriter?

open fun <T : Any?> getOption(key: TypedKey<T?>?): T?

getParentLogger

open override fun getParentLogger(): Logger

abstract fun isWrapperFor(p0: Class<*>?): Boolean

latestCompletedTxs

abstract fun latestCompletedTxs(): Map<DatabaseName, List<TransactionKey?>>

Each database's latest-completed transaction, per partition.

abstract fun <T : XtdbModule> module(type: Class<T>): T?

inline fun <T : XtdbModule> Xtdb.module(): T?

setLoginTimeout

open override fun setLoginTimeout(seconds: Int)

open override fun setLogWriter(out: PrintWriter?)

open fun <T : Any?> setOption(key: TypedKey<T?>?, value: T?)

abstract fun submitTx(ops: List<TxOp>, opts: TxOpts = TxOpts()): Xtdb.SubmittedTx

The transaction goes to TxOpts.dbName, defaulting to the primary database xtdb, and may only refer to tables within it — see Connection.

abstract fun <T : Any?> unwrap(p0: Class<T?>?): T?