Package-level declarations

Types

class AdbcDriverFactory : AdbcDriverFactory

@Serializable

data class CompactorConfig(var threads: Int = System.getenv("XTDB_COMPACTOR_THREADS")?.toIntOrNull() ?: DEFAULT_THREADS)

FlightSql

interface FlightSql : AutoCloseable

FlightSqlConfig

@Serializable

data class FlightSqlConfig(var host: String = "127.0.0.1", var port: Int = 0, var transactionIdleTimeout: Duration = Duration.ofMinutes(30), var preparedStatementIdleTimeout: Duration = Duration.ofMinutes(30), var sessionIdleTimeout: Duration = Duration.ofMinutes(30), var sessionUnclaimedTimeout: Duration = Duration.ofMinutes(1))

GarbageCollectorConfig

@Serializable

data class GarbageCollectorConfig(var enabled: Boolean = true, var blocksToKeep: Int = 10, var garbageLifetime: Duration = Duration.ofHours(24))

ICursor

interface ICursor : Spliterator<RelationReader> , AutoCloseable

IndexerConfig

@Serializable

data class IndexerConfig(var logLimit: Long = 64, var pageLimit: Long = 1024, var rowsPerBlock: Long = 102400, var flushDuration: Duration = Duration.ofMinutes(15), var skipTxs: List<MessageId> = System.getenv("XTDB_SKIP_TXS")?.let(::parseSkipTxsEnv).orEmpty(), var enabled: Boolean = true)

IngestNode

class IngestNode : AutoCloseable

A node that does nothing but ingest from external sources — it runs a Database per configured external source, joins leader election, and runs the source only on the database for which it's elected leader. There's no query/client surface: no pgwire, no Flight SQL — though it can serve the healthz endpoints (Config.healthz) for metrics and liveness.

PasswordHash

@Serializable

sealed interface PasswordHash

A stored password hash, tagged in YAML with the algorithm that produced it (!Argon2id, !BCrypt).

Principal

interface Principal

An authenticated user, as returned by Xtdb.authenticateWithPassword and its siblings. Xtdb.connect opens connections as one, attributing their writes to userId.

Remote

interface Remote : AutoCloseable

A named, node-local handle for an external system XT authenticates against — a Postgres instance, a cloud identity (AWS/Azure/GCP), etc.

RemoteAlias

typealias RemoteAlias = String

ResultCursor

interface ResultCursor : ICursor

ServerConfig

@Serializable

data class ServerConfig(var host: InetAddress? = InetAddress.getLoopbackAddress(), var port: Int = 0, var readOnlyPort: Int = -1, var numThreads: Int = 42, var ssl: ServerConfig.SslSettings? = null)

SingleRootUserAuthenticator

class SingleRootUserAuthenticator(password: String?) : Authenticator

UserListAuthenticator

class UserListAuthenticator(users: Map<String, PasswordHash>, rules: List<Authenticator.MethodRule>) : Authenticator

Xtdb

interface Xtdb : DataSource, AdbcDatabase, AutoCloseable

Properties

DEFAULT_RULES

val DEFAULT_RULES: List<Authenticator.MethodRule>

Functions

module

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