Package com.clickhouse.client.config

Enum ClickHouseDefaults

java.lang.Object

java.lang.Enum<ClickHouseDefaults>

com.clickhouse.client.config.ClickHouseDefaults

All Implemented Interfaces:

ClickHouseOption, Serializable, Comparable<ClickHouseDefaults>, java.lang.constant.Constable

public enum ClickHouseDefaults
extends Enum<ClickHouseDefaults>
implements ClickHouseOption

System-wide default options. System properties and environment variables can be set to change default value.

For example, by default ASYNC is set to true. However, you can change it to false by either specifying -Ddefault_async=false on the Java command line, or setting environment variable DEFAULT_ASYNC=false.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASYNC	Default execution mode.
AUTO_SESSION	Whether to create session automatically when there are multiple queries.
BUFFERING	Default buffering mode.
DATABASE	Default database.
FORMAT	Default format.
HOST	Default server host.
MAX_REQUESTS	Max requests.
MAX_SCHEDULER_THREADS	Maximum number of threads that the scheduler(shared by all client instances) can use to run the adhoc/scheduled tasks like discovery and health check.
MAX_THREADS	Max threads.
PASSWORD	Default password.
PROTOCOL	Default protocol.
ROUNDING_MODE	Rounding mode for type conversion.
SERVER_TIME_ZONE	Server time zone, defaults to UTC.
SERVER_VERSION	Server version, defaults to latest.
SRV_RESOLVE	Whether to resolve DNS SRV name using SrvResolver(e.g.
SSL_CERTIFICATE_TYPE	SSL certificiate type.
SSL_KEY_ALGORITHM	SSL key algorithm.
SSL_PROTOCOL	SSL key.
THREAD_KEEPALIVE_TIMEOUT	Thread keep alive timeout in milliseconds.
USER	Default user.

Method Summary

Modifier and Type	Method	Description
Serializable	getDefaultValue()
String	getDescription()
String	getKey()
String	getPrefix()
Class<? extends Serializable>	getValueType()
boolean	isSensitive()
static ClickHouseDefaults	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClickHouseDefaults[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.clickhouse.config.ClickHouseOption

getDefaultValueFromEnvVar, getDefaultValueFromSysProp, getEffectiveDefaultValue, getEffectiveValue, getEnvironmentVariable, getSystemProperty, name

Enum Constant Details

ASYNC

public static final ClickHouseDefaults ASYNC

Default execution mode.

AUTO_SESSION

public static final ClickHouseDefaults AUTO_SESSION

Whether to create session automatically when there are multiple queries.

BUFFERING

public static final ClickHouseDefaults BUFFERING

Default buffering mode.

HOST

public static final ClickHouseDefaults HOST

Default server host.

PROTOCOL

public static final ClickHouseDefaults PROTOCOL

Default protocol.

DATABASE

public static final ClickHouseDefaults DATABASE

Default database.

USER

public static final ClickHouseDefaults USER

Default user.

PASSWORD

public static final ClickHouseDefaults PASSWORD

Default password.

FORMAT

public static final ClickHouseDefaults FORMAT

Default format.

MAX_SCHEDULER_THREADS

public static final ClickHouseDefaults MAX_SCHEDULER_THREADS

Maximum number of threads that the scheduler(shared by all client instances) can use to run the adhoc/scheduled tasks like discovery and health check.

MAX_THREADS

public static final ClickHouseDefaults MAX_THREADS

Max threads.

MAX_REQUESTS

public static final ClickHouseDefaults MAX_REQUESTS

Max requests.

ROUNDING_MODE

public static final ClickHouseDefaults ROUNDING_MODE

Rounding mode for type conversion.

THREAD_KEEPALIVE_TIMEOUT

public static final ClickHouseDefaults THREAD_KEEPALIVE_TIMEOUT

Thread keep alive timeout in milliseconds.

SERVER_TIME_ZONE

public static final ClickHouseDefaults SERVER_TIME_ZONE

Server time zone, defaults to UTC.

SERVER_VERSION

public static final ClickHouseDefaults SERVER_VERSION

Server version, defaults to latest.

SSL_CERTIFICATE_TYPE

public static final ClickHouseDefaults SSL_CERTIFICATE_TYPE

SSL certificiate type.

SSL_KEY_ALGORITHM

public static final ClickHouseDefaults SSL_KEY_ALGORITHM

SSL key algorithm.

SSL_PROTOCOL

public static final ClickHouseDefaults SSL_PROTOCOL

SSL key.

SRV_RESOLVE

public static final ClickHouseDefaults SRV_RESOLVE

Whether to resolve DNS SRV name using SrvResolver(e.g. resolve SRV record to extract both host and port from a given name).

Method Details

values

public static ClickHouseDefaults[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClickHouseDefaults valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public Serializable getDefaultValue()

Specified by:

getDefaultValue in interface ClickHouseOption

getDescription

public String getDescription()

Specified by:

getDescription in interface ClickHouseOption

getKey

public String getKey()

Specified by:

getKey in interface ClickHouseOption

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface ClickHouseOption

getValueType

public Class<? extends Serializable> getValueType()

Specified by:

getValueType in interface ClickHouseOption

isSensitive

public boolean isSensitive()

Specified by:

isSensitive in interface ClickHouseOption