Package com.clickhouse.client.config

Enum ClickHouseClientOption

java.lang.Object

java.lang.Enum<ClickHouseClientOption>

com.clickhouse.client.config.ClickHouseClientOption

All Implemented Interfaces:

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

public enum ClickHouseClientOption
extends Enum<ClickHouseClientOption>
implements ClickHouseOption

Generic client options.

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	Whether the client should run in async mode(e.g.
AUTO_DISCOVERY	Whether the client should discover more nodes from system tables and/or clickhouse-keeper/zookeeper.
BUFFER_QUEUE_VARIATION	Number of times the buffer queue is filled up before increasing capacity of buffer queue.
BUFFER_SIZE	Default buffer size in byte for both request and response.
CHECK_ALL_NODES	Whether to perform health check against all nodes or just faulty ones.
CLIENT_NAME	Client name.
COMPRESS	Whether server will compress response to client or not.
COMPRESS_ALGORITHM	Compression algorithm server will use to compress response, when COMPRESS is true.
COMPRESS_LEVEL	Compression level for compressing server response.
CONNECTION_TIMEOUT	Connection timeout in milliseconds.
CUSTOM_SETTINGS	Custom server settings for all queries.
CUSTOM_SOCKET_FACTORY	Custom socket factory.
CUSTOM_SOCKET_FACTORY_OPTIONS	Additional socket factory options.
DATABASE	Default database.
DECOMPRESS	Whether server will decompress request from client or not.
DECOMPRESS_ALGORITHM	Compression algorithm server will use to decompress request, when DECOMPRESS is true.
DECOMPRESS_LEVEL	Compression level for decompress client request.
FAILOVER	Maximum number of times failover can happen for a request.
FORMAT	Default format.
HEALTH_CHECK_INTERVAL	Health check interval in milliseconds.
HEALTH_CHECK_METHOD	Health check method.
KEY_STORE_PASSWORD	Trust Store password.
KEY_STORE_TYPE	Key Store type.
LOAD_BALANCING_POLICY	Load balancing policy.
LOAD_BALANCING_TAGS	Load balancing tags for filtering out nodes.
LOG_LEADING_COMMENT	Whether to log leading comment(as log_comment in system.query_log) of the query.
MAX_BUFFER_SIZE	Maximum buffer size in byte can be used for streaming.
MAX_EXECUTION_TIME	Maximum query execution time in seconds.
MAX_MAPPER_CACHE	Maximum number of mappers can be cached.
MAX_QUEUED_BUFFERS	Maximum queued in-memory buffers.
MAX_QUEUED_REQUESTS	Maxium queued requests.
MAX_RESULT_ROWS	Maximum rows allowed in the result.
MAX_THREADS_PER_CLIENT	Maximum size of thread pool for each client.
NODE_CHECK_INTERVAL	Node check interval in milliseconds.
NODE_DISCOVERY_INTERVAL	Node discovery interval in milliseconds.
NODE_DISCOVERY_LIMIT	Maximum number of nodes can be discovered at a time.
NODE_GROUP_SIZE	Maximum number of nodes can be used for operation at a time.
PRODUCT_NAME	Product name usered in user agent.
PROXY_HOST	Set Clickhouse proxy hostname.
PROXY_PORT	Set ClickHouse proxy port.
PROXY_TYPE	Type of proxy can be used to access ClickHouse server.
READ_BUFFER_SIZE	Read buffer size in byte.
RENAME_RESPONSE_COLUMN	Method to rename response columns.
REPEAT_ON_SESSION_LOCK	Whether to repeat execution when session is locked, until timed out(according to SESSION_TIMEOUT or CONNECTION_TIMEOUT).
REQUEST_BUFFERING	Request buffering mode.
REQUEST_CHUNK_SIZE	Maximum request chunk size in byte.
RESPONSE_BUFFERING	Response buffering mode.
RETRY	Maximum number of times retry can happen for a request.
REUSE_VALUE_WRAPPER	Whether to reuse wrapper of value(e.g.
SERVER_REVISION	Server revision.
SERVER_TIME_ZONE	Server timezone.
SERVER_VERSION	Server version.
SESSION_CHECK	Whether to check if session id is validate.
SESSION_ID	Session id.
SESSION_TIMEOUT	Session timeout in seconds.
SOCKET_IP_TOS	Type-of-service(TOS) or traffic class field in the IP header for a socket.
SOCKET_KEEPALIVE	Whether to enable keep-alive packets for a socket connection.
SOCKET_LINGER	Seconds to wait while data is being transmitted before closing the socket.
SOCKET_RCVBUF	Size of the socket receive buffer in bytes.
SOCKET_REUSEADDR	Whether allows for the reuse of local addresses and ports.
SOCKET_SNDBUF	Size of the socket send buffer in bytes.
SOCKET_TCP_NODELAY	See StandardSocketOptions.TCP_NODELAY.
SOCKET_TIMEOUT	Socket timeout in milliseconds.
SSL	Whether to enable SSL for the connection.
SSL_CERTIFICATE	SSL certificiate.
SSL_KEY	SSL key.
SSL_MODE	SSL mode.
SSL_ROOT_CERTIFICATE	SSL root certificiate.
TRANSACTION_TIMEOUT	Transaction timeout in seconds.
TRUST_STORE	Trust Store.
USE_BINARY_STRING	Whether to support binary string.
USE_BLOCKING_QUEUE	Whether to use blocking queue for buffering.
USE_COMPILATION	Whether to use compilation(generated byte code) in object mapping and serialization.
USE_OBJECTS_IN_ARRAYS	Whether Object[] should be used instead of primitive arrays.
USE_SERVER_TIME_ZONE	Whether to use server time zone.
USE_SERVER_TIME_ZONE_FOR_DATES	Whether to use time zone from server for Date.
USE_TIME_ZONE	Custom time zone.
WIDEN_UNSIGNED_TYPES	Whether to convert unsigned types to the next widest type(e.g.
WRITE_BUFFER_SIZE	Write buffer size in byte.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_HOST	Client host name.
static final String	CLIENT_JVM_INFO	Client JVM information in format of <jvm name>/<jvm version>.
static final String	CLIENT_OS_INFO	Client O/S information in format of <o/s name>/<o/s version>.
static final String	CLIENT_USER	Client user name.
static final String	PRODUCT_REVISION	Revision(shortened git commit hash) of the product.
static final String	PRODUCT_VERSION	Semantic version of the product.

Method Summary

Modifier and Type	Method	Description
static final String	buildUserAgent(String productName, String additionalProperty)	Builds user-agent based on given product name.
static ClickHouseClientOption	fromKey(String key)	Gets client option by key.
Serializable	getDefaultValue()
String	getDescription()
String	getKey()
static String	getSystemConfig(String propertyName, String defaultValue)	Gets system property and fall back to the given value as needed.
Class<? extends Serializable>	getValueType()
boolean	isSensitive()
static ClickHouseClientOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClickHouseClientOption[]	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, getPrefix, getSystemProperty, name

Enum Constant Details

ASYNC

public static final ClickHouseClientOption ASYNC

Whether the client should run in async mode(e.g. ClickHouseClient.execute(com.clickhouse.client.ClickHouseRequest) in a separate thread).

AUTO_DISCOVERY

public static final ClickHouseClientOption AUTO_DISCOVERY

Whether the client should discover more nodes from system tables and/or clickhouse-keeper/zookeeper.

CUSTOM_SETTINGS

public static final ClickHouseClientOption CUSTOM_SETTINGS

Custom server settings for all queries.

CUSTOM_SOCKET_FACTORY

public static final ClickHouseClientOption CUSTOM_SOCKET_FACTORY

Custom socket factory.

CUSTOM_SOCKET_FACTORY_OPTIONS

public static final ClickHouseClientOption CUSTOM_SOCKET_FACTORY_OPTIONS

Additional socket factory options. Only useful only when CUSTOM_SOCKET_FACTORY is set.

LOAD_BALANCING_POLICY

public static final ClickHouseClientOption LOAD_BALANCING_POLICY

Load balancing policy.

LOAD_BALANCING_TAGS

public static final ClickHouseClientOption LOAD_BALANCING_TAGS

Load balancing tags for filtering out nodes.

HEALTH_CHECK_INTERVAL

public static final ClickHouseClientOption HEALTH_CHECK_INTERVAL

Health check interval in milliseconds.

HEALTH_CHECK_METHOD

public static final ClickHouseClientOption HEALTH_CHECK_METHOD

Health check method.

NODE_DISCOVERY_INTERVAL

public static final ClickHouseClientOption NODE_DISCOVERY_INTERVAL

Node discovery interval in milliseconds.

NODE_DISCOVERY_LIMIT

public static final ClickHouseClientOption NODE_DISCOVERY_LIMIT

Maximum number of nodes can be discovered at a time.

NODE_CHECK_INTERVAL

public static final ClickHouseClientOption NODE_CHECK_INTERVAL

Node check interval in milliseconds.

NODE_GROUP_SIZE

public static final ClickHouseClientOption NODE_GROUP_SIZE

Maximum number of nodes can be used for operation at a time.

CHECK_ALL_NODES

public static final ClickHouseClientOption CHECK_ALL_NODES

Whether to perform health check against all nodes or just faulty ones.

BUFFER_SIZE

public static final ClickHouseClientOption BUFFER_SIZE

Default buffer size in byte for both request and response. It will be reset to MAX_BUFFER_SIZE if it's too large.

BUFFER_QUEUE_VARIATION

public static final ClickHouseClientOption BUFFER_QUEUE_VARIATION

Number of times the buffer queue is filled up before increasing capacity of buffer queue. Zero or negative value means the queue length is fixed.

READ_BUFFER_SIZE

public static final ClickHouseClientOption READ_BUFFER_SIZE

Read buffer size in byte. It's mainly for input stream(e.g. reading data from server response). Its value defaults to BUFFER_SIZE, and it will be reset to MAX_BUFFER_SIZE when it's too large.

WRITE_BUFFER_SIZE

public static final ClickHouseClientOption WRITE_BUFFER_SIZE

Write buffer size in byte. It's mainly for output stream(e.g. writing data into request). Its value defaults to BUFFER_SIZE, and it will be reset to MAX_BUFFER_SIZE when it's too large.

REQUEST_CHUNK_SIZE

public static final ClickHouseClientOption REQUEST_CHUNK_SIZE

Maximum request chunk size in byte.

REQUEST_BUFFERING

public static final ClickHouseClientOption REQUEST_BUFFERING

Request buffering mode.

RESPONSE_BUFFERING

public static final ClickHouseClientOption RESPONSE_BUFFERING

Response buffering mode.

CLIENT_NAME

public static final ClickHouseClientOption CLIENT_NAME

Client name.

COMPRESS

public static final ClickHouseClientOption COMPRESS

Whether server will compress response to client or not.

DECOMPRESS

public static final ClickHouseClientOption DECOMPRESS

Whether server will decompress request from client or not.

COMPRESS_ALGORITHM

public static final ClickHouseClientOption COMPRESS_ALGORITHM

Compression algorithm server will use to compress response, when COMPRESS is true.

DECOMPRESS_ALGORITHM

public static final ClickHouseClientOption DECOMPRESS_ALGORITHM

Compression algorithm server will use to decompress request, when DECOMPRESS is true.

COMPRESS_LEVEL

public static final ClickHouseClientOption COMPRESS_LEVEL

Compression level for compressing server response.

DECOMPRESS_LEVEL

public static final ClickHouseClientOption DECOMPRESS_LEVEL

Compression level for decompress client request.

CONNECTION_TIMEOUT

public static final ClickHouseClientOption CONNECTION_TIMEOUT

Connection timeout in milliseconds.

DATABASE

public static final ClickHouseClientOption DATABASE

Default database.

FAILOVER

public static final ClickHouseClientOption FAILOVER

Maximum number of times failover can happen for a request.

FORMAT

public static final ClickHouseClientOption FORMAT

Default format.

LOG_LEADING_COMMENT

public static final ClickHouseClientOption LOG_LEADING_COMMENT

Whether to log leading comment(as log_comment in system.query_log) of the query.

MAX_BUFFER_SIZE

public static final ClickHouseClientOption MAX_BUFFER_SIZE

Maximum buffer size in byte can be used for streaming. It's not supposed to be larger than Integer.MAX_VALUE - 8.

MAX_MAPPER_CACHE

public static final ClickHouseClientOption MAX_MAPPER_CACHE

Maximum number of mappers can be cached.

MAX_EXECUTION_TIME

public static final ClickHouseClientOption MAX_EXECUTION_TIME

Maximum query execution time in seconds.

MAX_QUEUED_BUFFERS

public static final ClickHouseClientOption MAX_QUEUED_BUFFERS

Maximum queued in-memory buffers.

MAX_QUEUED_REQUESTS

public static final ClickHouseClientOption MAX_QUEUED_REQUESTS

Maxium queued requests. When MAX_THREADS_PER_CLIENT is greater than zero, this will also be applied to client's thread pool as well.

MAX_RESULT_ROWS

public static final ClickHouseClientOption MAX_RESULT_ROWS

Maximum rows allowed in the result.

MAX_THREADS_PER_CLIENT

public static final ClickHouseClientOption MAX_THREADS_PER_CLIENT

Maximum size of thread pool for each client.

PRODUCT_NAME

public static final ClickHouseClientOption PRODUCT_NAME

Product name usered in user agent.

RENAME_RESPONSE_COLUMN

public static final ClickHouseClientOption RENAME_RESPONSE_COLUMN

Method to rename response columns.

RETRY

public static final ClickHouseClientOption RETRY

Maximum number of times retry can happen for a request.

REPEAT_ON_SESSION_LOCK

public static final ClickHouseClientOption REPEAT_ON_SESSION_LOCK

Whether to repeat execution when session is locked, until timed out(according to SESSION_TIMEOUT or CONNECTION_TIMEOUT).

REUSE_VALUE_WRAPPER

public static final ClickHouseClientOption REUSE_VALUE_WRAPPER

Whether to reuse wrapper of value(e.g. ClickHouseValue or ClickHouseRecord) for memory efficiency.

SERVER_REVISION

public static final ClickHouseClientOption SERVER_REVISION

Server revision.

SERVER_TIME_ZONE

public static final ClickHouseClientOption SERVER_TIME_ZONE

Server timezone.

SERVER_VERSION

public static final ClickHouseClientOption SERVER_VERSION

Server version.

SESSION_ID

public static final ClickHouseClientOption SESSION_ID

Session id.

SESSION_CHECK

public static final ClickHouseClientOption SESSION_CHECK

Whether to check if session id is validate.

SESSION_TIMEOUT

public static final ClickHouseClientOption SESSION_TIMEOUT

Session timeout in seconds.

SOCKET_TIMEOUT

public static final ClickHouseClientOption SOCKET_TIMEOUT

Socket timeout in milliseconds.

SOCKET_REUSEADDR

public static final ClickHouseClientOption SOCKET_REUSEADDR

Whether allows for the reuse of local addresses and ports. See StandardSocketOptions.SO_REUSEADDR.

SOCKET_KEEPALIVE

public static final ClickHouseClientOption SOCKET_KEEPALIVE

Whether to enable keep-alive packets for a socket connection. See StandardSocketOptions.SO_KEEPALIVE.

SOCKET_LINGER

public static final ClickHouseClientOption SOCKET_LINGER

Seconds to wait while data is being transmitted before closing the socket. Use negative number to disable the option. See StandardSocketOptions.SO_LINGER.

SOCKET_IP_TOS

public static final ClickHouseClientOption SOCKET_IP_TOS

Type-of-service(TOS) or traffic class field in the IP header for a socket. See StandardSocketOptions.IP_TOS.

SOCKET_TCP_NODELAY

public static final ClickHouseClientOption SOCKET_TCP_NODELAY

See StandardSocketOptions.TCP_NODELAY.

SOCKET_RCVBUF

public static final ClickHouseClientOption SOCKET_RCVBUF

Size of the socket receive buffer in bytes. See StandardSocketOptions.SO_RCVBUF.

SOCKET_SNDBUF

public static final ClickHouseClientOption SOCKET_SNDBUF

Size of the socket send buffer in bytes. See StandardSocketOptions.SO_SNDBUF.

SSL

public static final ClickHouseClientOption SSL

Whether to enable SSL for the connection.

SSL_MODE

public static final ClickHouseClientOption SSL_MODE

SSL mode.

SSL_ROOT_CERTIFICATE

public static final ClickHouseClientOption SSL_ROOT_CERTIFICATE

SSL root certificiate.

SSL_CERTIFICATE

public static final ClickHouseClientOption SSL_CERTIFICATE

SSL certificiate.

SSL_KEY

public static final ClickHouseClientOption SSL_KEY

SSL key.

KEY_STORE_TYPE

public static final ClickHouseClientOption KEY_STORE_TYPE

Key Store type.

TRUST_STORE

public static final ClickHouseClientOption TRUST_STORE

Trust Store.

KEY_STORE_PASSWORD

public static final ClickHouseClientOption KEY_STORE_PASSWORD

Trust Store password.

TRANSACTION_TIMEOUT

public static final ClickHouseClientOption TRANSACTION_TIMEOUT

Transaction timeout in seconds.

WIDEN_UNSIGNED_TYPES

public static final ClickHouseClientOption WIDEN_UNSIGNED_TYPES

Whether to convert unsigned types to the next widest type(e.g. use short for UInt8 instead of byte, and UnsignedLong for UInt64).

USE_BINARY_STRING

public static final ClickHouseClientOption USE_BINARY_STRING

Whether to support binary string. Enable this option to treat FixedString and String as byte array.

USE_BLOCKING_QUEUE

public static final ClickHouseClientOption USE_BLOCKING_QUEUE

Whether to use blocking queue for buffering.

USE_COMPILATION

public static final ClickHouseClientOption USE_COMPILATION

Whether to use compilation(generated byte code) in object mapping and serialization.

USE_OBJECTS_IN_ARRAYS

public static final ClickHouseClientOption USE_OBJECTS_IN_ARRAYS

Whether Object[] should be used instead of primitive arrays.

PROXY_TYPE

public static final ClickHouseClientOption PROXY_TYPE

Type of proxy can be used to access ClickHouse server. To use an HTTP/SOCKS proxy, you must specify the PROXY_HOST and PROXY_PORT.

PROXY_HOST

public static final ClickHouseClientOption PROXY_HOST

Set Clickhouse proxy hostname.

PROXY_PORT

public static final ClickHouseClientOption PROXY_PORT

Set ClickHouse proxy port.

USE_SERVER_TIME_ZONE

public static final ClickHouseClientOption USE_SERVER_TIME_ZONE

Whether to use server time zone.

USE_SERVER_TIME_ZONE_FOR_DATES

public static final ClickHouseClientOption USE_SERVER_TIME_ZONE_FOR_DATES

Whether to use time zone from server for Date.

USE_TIME_ZONE

public static final ClickHouseClientOption USE_TIME_ZONE

Custom time zone. Only works when use_server_time_zone is set to false.

Field Details

PRODUCT_VERSION

public static final String PRODUCT_VERSION

Semantic version of the product.

PRODUCT_REVISION

public static final String PRODUCT_REVISION

Revision(shortened git commit hash) of the product.

CLIENT_OS_INFO

public static final String CLIENT_OS_INFO

Client O/S information in format of <o/s name>/<o/s version>.

CLIENT_JVM_INFO

public static final String CLIENT_JVM_INFO

Client JVM information in format of <jvm name>/<jvm version>.

CLIENT_USER

public static final String CLIENT_USER

Client user name.

CLIENT_HOST

public static final String CLIENT_HOST

Client host name.

Method Details

values

public static ClickHouseClientOption[] 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 ClickHouseClientOption 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

buildUserAgent

public static final String buildUserAgent(String productName,
 String additionalProperty)

Builds user-agent based on given product name. The user-agent will be something look like <product name>/<product version> (<o/s name>/<o/s version>; <jvm name>/<jvm version>[; <additionalProperty>]; rv:<product revision>).

Parameters:

productName - product name, null or blank string is treated as ClickHouse Java Client

additionalProperty - additional property if any

Returns:

non-empty user-agent

getSystemConfig

public static String getSystemConfig(String propertyName,
 String defaultValue)

Gets system property and fall back to the given value as needed.

Parameters:

propertyName - non-null property name

defaultValue - default value, only useful if it's not null

Returns:

property value

fromKey

public static ClickHouseClientOption fromKey(String key)

Gets client option by key.

Parameters:

key - key of the option

Returns:

client option object, or null if not found

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

getValueType

public Class<? extends Serializable> getValueType()

Specified by:

getValueType in interface ClickHouseOption

isSensitive

public boolean isSensitive()

Specified by:

isSensitive in interface ClickHouseOption