Package-level declarations

Types

Link copied to clipboard
class AdbcDriverFactory : AdbcDriverFactory
Link copied to clipboard
Link copied to clipboard
interface AuthResult
Link copied to clipboard
@Serializable
data class CompactorConfig(var threads: Int = System.getenv("XTDB_COMPACTOR_THREADS")?.toIntOrNull() ?: DEFAULT_THREADS)
Link copied to clipboard
Link copied to clipboard
@Serializable
data class FlightSqlConfig(var host: String = "127.0.0.1", var port: Int = 0)
Link copied to clipboard
@Serializable
data class GarbageCollectorConfig(var enabled: Boolean = false, var blocksToKeep: Int = 10, var garbageLifetime: Duration = Duration.ofHours(24))
Link copied to clipboard
Link copied to clipboard
@Serializable
data class IndexerConfig(var logLimit: Long = 64, var pageLimit: Long = 1024, var rowsPerBlock: Long = 102400, var flushDuration: Duration = Duration.ofHours(4), var skipTxs: List<MessageId> = System.getenv("XTDB_SKIP_TXS")?.let(::parseSkipTxsEnv).orEmpty(), var enabled: Boolean = true)
Link copied to clipboard
object InetAddressSerde : KSerializer<InetAddress?>
Link copied to clipboard

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.

Link copied to clipboard
data class OAuthClientCredentialsResult(val userId: String, var expiresAt: Instant, val accessToken: String, val clientId: String, val clientSecret: String) : OAuthResult
Link copied to clipboard
data class OAuthPasswordResult(val userId: String, var expiresAt: Instant, val accessToken: String, val refreshToken: String) : OAuthResult
Link copied to clipboard
Link copied to clipboard
@Serializable
sealed interface PasswordHash

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

Link copied to clipboard
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.

Link copied to clipboard
typealias RemoteAlias = String
Link copied to clipboard
interface ResultCursor : ICursor
Link copied to clipboard
@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)
Link copied to clipboard
data class SimpleResult(val userId: String) : AuthResult
Link copied to clipboard
Link copied to clipboard
interface Xtdb : DataSource, AdbcDatabase, AutoCloseable

Properties

Link copied to clipboard

Functions

Link copied to clipboard
inline fun <T : XtdbModule> Xtdb.module(): T?