java.lang.Object
- java.lang.Enum<ClickHouseClientOption>
- - com.clickhouse.client.config.ClickHouseClientOption

All Implemented Interfaces:

ClickHouseOption, Serializable, Comparable<ClickHouseClientOption>
```
public enum ClickHouseClientOption
extends Enum<ClickHouseClientOption>
implements ClickHouseOption
```
Generic client options.

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.
`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.
`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_COMPRESS_BLOCK_SIZE`	Deprecated. will be removed in v0.3.3
`MAX_EXECUTION_TIME`	Maximum query execution time in seconds.
`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.
`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.
`SERVER_WEIGHT`	Deprecated. will be removed in v0.3.3
`SESSION_CHECK`	Whether to check if session id is validate.
`SESSION_ID`	Session id.
`SESSION_TIMEOUT`	Session timeout in seconds.
`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.
`USE_BLOCKING_QUEUE`	Whether to use blocking queue for buffering.
`USE_NO_PROXY`	Whether to access ClickHouse server directly without using system wide proxy including the one defined in JVM system properties.
`USE_OBJECTS_IN_ARRAYS`	Whether to use objects in array or not.
`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.
`WRITE_BUFFER_SIZE`	Write buffer size in byte.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ClickHouseClientOption`	`fromKey(String key)`	Gets client option by key.
`Serializable`	`getDefaultValue()`	Gets default value of the option.
`String`	`getDescription()`	Gets description of the option.
`String`	`getKey()`	Gets key of the option.
`Class<? extends Serializable>`	`getValueType()`	Gets value type of the option.
`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, 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.client.config.ClickHouseOption
getDefaultValueFromEnvVar, getDefaultValueFromSysProp, getEffectiveDefaultValue, getEffectiveValue, getEnvironmentVariable, getPrefix, getSystemProperty, name

- Enum Constant Detail
  - 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.
  - 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_COMPRESS_BLOCK_SIZE
```
@Deprecated
public static final ClickHouseClientOption MAX_COMPRESS_BLOCK_SIZE
```
    Deprecated.
    will be removed in v0.3.3
    
    Maximum comression block size in byte, only useful when DECOMPRESS is true.
  - 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.
  - 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.
  - SERVER_WEIGHT
```
@Deprecated
public static final ClickHouseClientOption SERVER_WEIGHT
```
    Deprecated.
    will be removed in v0.3.3
    
    Server weight.
  - 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.
  - 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.
  - TRANSACTION_TIMEOUT
```
public static final ClickHouseClientOption TRANSACTION_TIMEOUT
```
    Transaction timeout in seconds.
  - USE_BLOCKING_QUEUE
```
public static final ClickHouseClientOption USE_BLOCKING_QUEUE
```
    Whether to use blocking queue for buffering.
  - USE_OBJECTS_IN_ARRAYS
```
public static final ClickHouseClientOption USE_OBJECTS_IN_ARRAYS
```
    Whether to use objects in array or not.
  - USE_NO_PROXY
```
public static final ClickHouseClientOption USE_NO_PROXY
```
    Whether to access ClickHouse server directly without using system wide proxy including the one defined in JVM system properties.
  - 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.
- Method Detail
  - values
```
public static ClickHouseClientOption[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ClickHouseClientOption c : ClickHouseClientOption.values()) System.out.println(c);
    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
  - 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()
```
    Description copied from interface: ClickHouseOption
    
    Gets default value of the option.
    
    Specified by:
    
    getDefaultValue in interface ClickHouseOption
    
    Returns:
    
    default value of the option
  - getDescription
```
public String getDescription()
```
    Description copied from interface: ClickHouseOption
    
    Gets description of the option.
    
    Specified by:
    
    getDescription in interface ClickHouseOption
    
    Returns:
    
    description of the option
  - getKey
```
public String getKey()
```
    Description copied from interface: ClickHouseOption
    
    Gets key of the option.
    
    Specified by:
    
    getKey in interface ClickHouseOption
    
    Returns:
    
    key of the option
  - getValueType
```
public Class<? extends Serializable> getValueType()
```
    Description copied from interface: ClickHouseOption
    
    Gets value type of the option.
    
    Specified by:
    
    getValueType in interface ClickHouseOption
    
    Returns:
    
    value type of the option, defaults to String

Enum ClickHouseClientOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.clickhouse.client.config.ClickHouseOption

Enum Constant Detail

ASYNC

AUTO_DISCOVERY

LOAD_BALANCING_POLICY

LOAD_BALANCING_TAGS

HEALTH_CHECK_INTERVAL

HEALTH_CHECK_METHOD

NODE_DISCOVERY_INTERVAL

NODE_DISCOVERY_LIMIT

NODE_CHECK_INTERVAL

NODE_GROUP_SIZE

CHECK_ALL_NODES

BUFFER_SIZE

BUFFER_QUEUE_VARIATION

READ_BUFFER_SIZE

WRITE_BUFFER_SIZE

REQUEST_CHUNK_SIZE

REQUEST_BUFFERING

RESPONSE_BUFFERING

CLIENT_NAME

COMPRESS

DECOMPRESS

COMPRESS_ALGORITHM

DECOMPRESS_ALGORITHM

COMPRESS_LEVEL

DECOMPRESS_LEVEL

CONNECTION_TIMEOUT

DATABASE

FAILOVER

FORMAT

LOG_LEADING_COMMENT

MAX_BUFFER_SIZE

MAX_COMPRESS_BLOCK_SIZE

MAX_EXECUTION_TIME

MAX_QUEUED_BUFFERS

MAX_QUEUED_REQUESTS

MAX_RESULT_ROWS

MAX_THREADS_PER_CLIENT

RENAME_RESPONSE_COLUMN

RETRY

REPEAT_ON_SESSION_LOCK

REUSE_VALUE_WRAPPER

SERVER_REVISION

SERVER_TIME_ZONE

SERVER_VERSION

SERVER_WEIGHT

SESSION_ID

SESSION_CHECK

SESSION_TIMEOUT

SOCKET_TIMEOUT

SSL

SSL_MODE

SSL_ROOT_CERTIFICATE

SSL_CERTIFICATE

SSL_KEY

TRANSACTION_TIMEOUT

USE_BLOCKING_QUEUE

USE_OBJECTS_IN_ARRAYS

USE_NO_PROXY

USE_SERVER_TIME_ZONE

USE_SERVER_TIME_ZONE_FOR_DATES

USE_TIME_ZONE

Method Detail

values

valueOf

fromKey

getDefaultValue

getDescription

getKey

getValueType