xtdb-core/xtdb.api/Xtdb

Xtdb

interface Xtdb : DataSource, AdbcDatabase, AutoCloseable

Types

CompactorNode

interface CompactorNode : AutoCloseable

Companion

object Companion

Config

@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 != '-' })

Connection

class Connection : AdbcConnection

A connection to one database, dbName.

DeviceAuth

interface DeviceAuth

ExecutedTx

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

Statement

interface Statement : AdbcStatement

A statement on a Connection.

SubmittedTx

data class SubmittedTx(val txId: MessageId)

Properties

allocator

abstract val allocator: BufferAllocator

awaitToken

abstract var awaitToken: String

connection

open val connection: Connection

databaseNames

abstract val databaseNames: Collection<DatabaseName>

The names of the databases this node currently serves.

flightSqlPort

abstract val flightSqlPort: Int

healthzPort

abstract val healthzPort: Int

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

loginTimeout

open var loginTimeout: Int

logWriter

open var logWriter: PrintWriter?

parentLogger

open val parentLogger: Logger

serverPort

abstract val serverPort: Int

serverReadOnlyPort

abstract val serverReadOnlyPort: Int

Functions

addMeterRegistry

abstract fun addMeterRegistry(meterRegistry: MeterRegistry)

authenticateTrusted

abstract fun authenticateTrusted(user: String): Principal

user, taken at its word: neither credentials nor the node's authn rules are checked, so this authenticates any user, superuser included. Where the rules should decide, consult authMethodFor first.

authenticateWithClientCredentials

abstract fun authenticateWithClientCredentials(clientId: String, clientSecret: String): Principal

The client clientId, having verified clientSecret with the node's authenticator (the OAuth client-credentials flow). The principal's user id is the one the authenticator resolves for that client.

authenticateWithPassword

abstract fun authenticateWithPassword(user: String, password: String): Principal

user, having verified password with the node's authenticator. The principal's user id is the one the authenticator resolves — for OIDC, the token's subject.

authMethodFor

abstract fun authMethodFor(user: String?, remoteAddress: String?): Authenticator.Method?

The authentication method the node's configured authn rules ask of a caller claiming user from remoteAddress, or null if no rule matches and the caller is to be rejected.

abstract fun close()

connect

abstract override fun connect(): Xtdb.Connection

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

Opens an in-process connection to the named database.

abstract fun connect(dbName: DatabaseName, principal: Principal): Xtdb.Connection

Opens an in-process connection to the named database as principal: the connection's Connection.user is the principal's user id. The node doesn't check principal — obtain one from the authenticate… methods below.