xtdb-core/xtdb.api/Xtdb/Config

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

Constructors

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

Properties

var allocator: BufferAllocator?

var authn: Authenticator.Factory

val compactor: CompactorConfig

var defaultTz: ZoneId

var diskCache: DiskCache.Factory?

var flightSql: FlightSqlConfig?

garbageCollector

var garbageCollector: GarbageCollectorConfig

var healthz: HealthzConfig?

val indexer: IndexerConfig

var log: Log.Factory

var logClusters: Map<RemoteAlias, Remote.Factory<*>>

val memoryCache: MemoryCache.Factory

var nodeId: String

readOnlyDatabases

var readOnlyDatabases: Boolean

var remotes: Map<RemoteAlias, Remote.Factory<*>>

var server: ServerConfig?

var skipDbs: Set<String>

var storage: Storage.Factory

var tracer: TracerConfig

Functions

fun authn(authn: Authenticator.Factory): Xtdb.Config

fun compactor(configure: CompactorConfig.() -> Unit): Xtdb.Config

fun defaultTz(defaultTz: ZoneId): Xtdb.Config

fun diskCache(diskCache: DiskCache.Factory?): Xtdb.Config

fun flightSql(configure: FlightSqlConfig.() -> Unit): Xtdb.Config

garbageCollector

fun garbageCollector(configure: GarbageCollectorConfig.() -> Unit): Xtdb.Config

fun garbageCollector(garbageCollector: GarbageCollectorConfig): Xtdb.Config

fun getModules(): List<XtdbModule.Factory>

fun healthz(healthz: HealthzConfig): Xtdb.Config

fun indexer(configure: IndexerConfig.() -> Unit): Xtdb.Config

fun log(log: Log.Factory): Xtdb.Config

fun logCluster(alias: RemoteAlias, cluster: Remote.Factory<*>): Xtdb.Config

fun logClusters(clusters: Map<RemoteAlias, Remote.Factory<*>>): Xtdb.Config

fun module(module: XtdbModule.Factory): Xtdb.Config

fun modules(modules: List<XtdbModule.Factory>): Xtdb.Config

fun modules(vararg modules: XtdbModule.Factory): Xtdb.Config

fun nodeId(nodeId: String): Xtdb.Config

fun open(): Xtdb

fun openCompactor(): Xtdb.CompactorNode

readOnlyDatabases

fun readOnlyDatabases(readOnlyDatabases: Boolean = true): Xtdb.Config

fun remote(alias: RemoteAlias, remote: Remote.Factory<*>): Xtdb.Config

fun remotes(remotes: Map<RemoteAlias, Remote.Factory<*>>): Xtdb.Config

fun server(configure: ServerConfig.() -> Unit): Xtdb.Config

fun skipDbs(skipDbs: Set<String>): Xtdb.Config

fun storage(storage: Storage.Factory): Xtdb.Config

fun tracer(configure: TracerConfig.() -> Unit): Xtdb.Config

fun tracer(tracer: TracerConfig): Xtdb.Config