kandra-ktor/io.kandra.ktor/KandraConfig

KandraConfig

class KandraConfig

Configuration for the Kandra Ktor plugin.

install(Kandra) {
    contactPoints = "localhost:9042"
    keyspace = "coinx"
    localDatacenter = "datacenter1"
    autoCreateKeyspace = true
    schemaMode = SchemaMode.AUTO_CREATE
    register(User::class, Wallet::class)
    pool { requestTimeoutMillis = 10_000 }
    auth { provider = KandraAuth.fromEnv() }
    retry { maxAttempts = 5 }
    debug { logQueries = true; logSlowQueriesMs = 500 }
    validate<User> { user ->
        buildList { if (user.email.isBlank()) add(KandraValidationError("email", "cannot be blank")) }
    }
}

Constructors

constructor()

Properties

val auth: AuthConfig

autoCreateKeyspace

var autoCreateKeyspace: Boolean

var batchAutoChunk: Boolean

When true, large batches are automatically split into chunks of batchMaxChunkSize.

batchMaxChunkSize

var batchMaxChunkSize: Int

Maximum statements per batch chunk when auto-chunking.

batchWarnThresholdKb

var batchWarnThresholdKb: Int

Batch warn threshold in KB — logs WARN when a batch exceeds this size estimate.

val codec: KandraCodec

val consistency: ConsistencyConfig

var contactPoints: String

val debug: DebugConfig

var eventListener: KandraEventListener?

val failover: FailoverConfig

var healthCheck: Boolean

When true, registers a /kandra/health route (and Ktor HealthCheck integration if available).

var keyspace: String

val loadBalancing: LoadBalancingConfig

localDatacenter

var localDatacenter: String

val metrics: MetricsConfig

val pool: PoolConfig

preparedStatementCacheSize

var preparedStatementCacheSize: Int

replicationStrategy

var replicationStrategy: ReplicationStrategy

val retry: RetryConfig

var schemaMode: SchemaMode

val shutdown: ShutdownConfig

speculativeExecution

val speculativeExecution: SpeculativeExecutionConfig

val ssl: SslConfig

tombstoneWarnThreshold

var tombstoneWarnThreshold: Int

Log WARN when deleteBy/deleteAll would generate more than this many tombstones.

validatePermissions

var validatePermissions: Boolean

When true, validates keyspace permissions at startup (SELECT + MODIFY required).

Functions

fun auth(block: AuthConfig.() -> Unit)

fun consistency(block: ConsistencyConfig.() -> Unit)

fun debug(block: DebugConfig.() -> Unit)

fun failover(block: FailoverConfig.() -> Unit)

fun loadBalancing(block: LoadBalancingConfig.() -> Unit)

fun metrics(block: MetricsConfig.() -> Unit)

fun pool(block: PoolConfig.() -> Unit)

fun register(vararg classes: KClass<*>)

fun retry(block: RetryConfig.() -> Unit)

fun shutdown(block: ShutdownConfig.() -> Unit)

speculativeExecution

fun speculativeExecution(block: SpeculativeExecutionConfig.() -> Unit)

fun ssl(block: SslConfig.() -> Unit)

inline fun <T : Any> validate(noinline validator: (T) -> List<KandraValidationError>)

fun <T : Any> validate(klass: KClass<T>, validator: KandraValidator<T>)