wow-spring-boot-starter/me.ahoo.wow.spring.boot.starter.clickhouse/ClickHouseDatasetProperties

ClickHouseDatasetProperties

@ConfigurationProperties(prefix = "wow.query.clickhouse")

data class ClickHouseDatasetProperties(var enabled: Boolean = false, var endpoints: List<URI> = emptyList(), var username: String = "default", var password: String = "", var database: String = "default", var connectionTimeout: Duration = Duration.ofSeconds(5), var socketTimeout: Duration = Duration.ofSeconds(60), var maxConnections: Int = 16, var metadataTtl: Duration = Duration.ofMinutes(1), var http: ClickHouseDatasetProperties.HttpLimits = HttpLimits(), var inProcess: ClickHouseDatasetProperties.Limits = Limits(), var sources: Map<String, ClickHouseDatasetProperties.Source> = emptyMap())

The ClickHouse server the datasets of wow.query.datasets are read from (clickhouse-support).

Constructors

constructor(enabled: Boolean = false, endpoints: List<URI> = emptyList(), username: String = "default", password: String = "", database: String = "default", connectionTimeout: Duration = Duration.ofSeconds(5), socketTimeout: Duration = Duration.ofSeconds(60), maxConnections: Int = 16, metadataTtl: Duration = Duration.ofMinutes(1), http: ClickHouseDatasetProperties.HttpLimits = HttpLimits(), inProcess: ClickHouseDatasetProperties.Limits = Limits(), sources: Map<String, ClickHouseDatasetProperties.Source> = emptyMap())

Types

Companion

object Companion

HttpLimits

data class HttpLimits(@DefaultValue(value = ["30s"]) var maxExecutionTime: Duration? = Duration.ofSeconds(30), var maxRowsToRead: Long? = null, var maxResultRows: Long? = null, @DefaultValue(value = ["4294967296"]) var maxMemoryUsage: Long? = 4L * 1024 * 1024 * 1024)

What one HTTP query may cost: 30 seconds and 4 GiB of memory unless set; untrusted callers get a bound.

Limits

data class Limits(var maxExecutionTime: Duration? = null, var maxRowsToRead: Long? = null, var maxResultRows: Long? = null, var maxMemoryUsage: Long? = null)

What one query may cost; unset leaves the server's own setting.

Source

data class Source(var endpoints: List<URI> = emptyList(), var username: String = "default", var password: String = "", var database: String = "default", var connectionTimeout: Duration = Duration.ofSeconds(5), var socketTimeout: Duration = Duration.ofSeconds(60), var maxConnections: Int = 16)

One named ClickHouse server: its connection, as the default source's settings say for it.

Properties

connectionTimeout

var connectionTimeout: Duration

how long to wait for a connection.

database

var database: String

the database of a dataset whose storage.table names none.

enabled

var enabled: Boolean

serves datasets from ClickHouse.

endpoints

var endpoints: List<URI>

the HTTP endpoints, such as http://clickhouse:8123.

http

var http: ClickHouseDatasetProperties.HttpLimits

the limits of an HTTP query, sent as server settings; an over-limit query fails.

inProcess

var inProcess: ClickHouseDatasetProperties.Limits

the limits of an in-process query; none by default, as in-process callers are trusted code.

maxConnections

var maxConnections: Int

the connection pool limit.

metadataTtl

var metadataTtl: Duration

how long a table's columns and engine are reused before system.columns is read again.

password

var password: String

the account's password.

socketTimeout

var socketTimeout: Duration

how long to wait for a response to make progress.

sources

var sources: Map<String, ClickHouseDatasetProperties.Source>

other ClickHouse servers, by name, that a dataset reads from when its storage.source names one (dataset platform design §5.1); the settings above are the default source's. The limits apply to every source.

username

var username: String

the account; give Wow a read-only one.

Functions

defaultSource

fun defaultSource(): ClickHouseDatasetProperties.Source

The default source's connection, as a Source.

toOptions

fun toOptions(): ClickHouseDatasetOptions