java.lang.Object
- com.clickhouse.client.ClickHouseConfig

All Implemented Interfaces:

Serializable
```
public class ClickHouseConfig
extends Object
implements Serializable
```
An immutable class holding client-specific options like ClickHouseCredentials and ClickHouseNodeSelector etc.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ClickHouseConfig(ClickHouseConfig... configs)`	Construct a new configuration by consolidating given ones.
`ClickHouseConfig(List<ClickHouseConfig> configs)`	Construct a new configuration by consolidating given ones.
`ClickHouseConfig(Map<ClickHouseOption,Serializable> options, ClickHouseCredentials credentials, ClickHouseNodeSelector nodeSelector, Object metricRegistry)`	Default contructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Map<ClickHouseOption,Serializable>`	`getAllOptions()`
`int`	`getBufferQueueVariation()`	Gets number of times the buffer queue is filled up before increasing capacity of buffer queue.
`int`	`getBufferSize()`	Gets default buffer size in byte for both read and write.
`String`	`getClientName()`
`ClickHouseCompression`	`getCompressAlgorithmForServerResponse()`	Deprecated. will be removed in v0.3.3, please use `getResponseCompressAlgorithm()` instead
`int`	`getCompressLevelForServerResponse()`	Deprecated. will be removed in v0.3.3, please use `getResponseCompressLevel()` instead
`int`	`getConnectionTimeout()`
`String`	`getDatabase()`
`ClickHouseCompression`	`getDecompressAlgorithmForClientRequest()`	Deprecated. will be removed in v0.3.3, please use `getRequestCompressAlgorithm()` instead
`int`	`getDecompressLevelForClientRequest()`	Deprecated. will be removed in v0.3.3, please use `getRequestCompressLevel()` instead
`ClickHouseCredentials`	`getDefaultCredentials()`
`int`	`getFailover()`
`ClickHouseFormat`	`getFormat()`
`int`	`getMaxBufferSize()`	Gets max buffer size in byte can be used for streaming.
`int`	`getMaxExecutionTime()`
`int`	`getMaxQueuedBuffers()`
`int`	`getMaxQueuedRequests()`
`long`	`getMaxResultRows()`
`int`	`getMaxThreadsPerClient()`
`Optional<Object>`	`getMetricRegistry()`
`int`	`getNodeCheckInterval()`
`ClickHouseNodeSelector`	`getNodeSelector()`
`Serializable`	`getOption(ClickHouseOption option)`
`Serializable`	`getOption(ClickHouseOption option, ClickHouseConfig defaultConfig)`
`Serializable`	`getOption(ClickHouseOption option, ClickHouseDefaults defaultValue)`
`List<ClickHouseProtocol>`	`getPreferredProtocols()`
`Set<String>`	`getPreferredTags()`
`int`	`getReadBufferSize()`	Gets read buffer size in byte.
`ClickHouseBufferingMode`	`getRequestBuffering()`	Gets request buffering mode.
`int`	`getRequestChunkSize()`	Gets request chunk size.
`ClickHouseCompression`	`getRequestCompressAlgorithm()`	Gets input compress algorithm.
`int`	`getRequestCompressLevel()`	Gets input compress level.
`ClickHouseBufferingMode`	`getResponseBuffering()`	Gets response buffering mode.
`ClickHouseCompression`	`getResponseCompressAlgorithm()`	Gets server response compress algorithm.
`int`	`getResponseCompressLevel()`	Gets input compress level.
`int`	`getRetry()`
`TimeZone`	`getServerTimeZone()`
`ClickHouseVersion`	`getServerVersion()`
`int`	`getSessionTimeout()`
`int`	`getSocketTimeout()`
`String`	`getSslCert()`
`String`	`getSslKey()`
`ClickHouseSslMode`	`getSslMode()`
`String`	`getSslRootCert()`
`TimeZone`	`getTimeZoneForDate()`	Gets time zone for date values.
`int`	`getTransactionTimeout()`
`TimeZone`	`getUseTimeZone()`	Gets preferred time zone.
`int`	`getWriteBufferSize()`	Gets write buffer size in byte.
`int`	`hashCode()`
`boolean`	`hasOption(ClickHouseOption option)`	Test whether a given option is configured or not.
`boolean`	`hasServerInfo()`	Checks whether we got all server information(e.g.
`boolean`	`isAsync()`
`boolean`	`isAutoDiscovery()`
`boolean`	`isCompressServerResponse()`	Deprecated. will be removed in v0.3.3, please use `isResponseCompressed()` instead
`boolean`	`isDecompressClientRequet()`	Deprecated. will be removed in v0.3.3, please use `isRequestCompressed()` instead
`boolean`	`isRepeatOnSessionLock()`
`boolean`	`isRequestCompressed()`	Checks if client's output, aka.
`boolean`	`isResponseCompressed()`	Checks if server response is compressed or not.
`boolean`	`isRetry()`	Deprecated. will be removed in v0.3.3, please use `getRetry()` instead
`boolean`	`isReuseValueWrapper()`
`boolean`	`isSessionCheck()`
`boolean`	`isSsl()`
`boolean`	`isUseBlockingQueue()`
`boolean`	`isUseNoProxy()`
`boolean`	`isUseObjectsInArray()`
`boolean`	`isUseServerTimeZone()`
`boolean`	`isUseServerTimeZoneForDates()`
`protected static ClickHouseCredentials`	`mergeCredentials(List<ClickHouseConfig> list)`
`protected static Object`	`mergeMetricRegistry(List<ClickHouseConfig> list)`
`protected static ClickHouseNodeSelector`	`mergeNodeSelector(List<ClickHouseConfig> list)`
`protected static Map<ClickHouseOption,Serializable>`	`mergeOptions(List<ClickHouseConfig> list)`
`static Map<ClickHouseOption,Serializable>`	`toClientOptions(Map<?,?> props)`	Converts given key-value pairs to a mutable map of corresponding `ClickHouseOption`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ClickHouseConfig
```
public ClickHouseConfig(ClickHouseConfig... configs)
```
    Construct a new configuration by consolidating given ones.
    
    Parameters:
    
    configs - list of configuration
  - ClickHouseConfig
```
public ClickHouseConfig(List<ClickHouseConfig> configs)
```
    Construct a new configuration by consolidating given ones.
    
    Parameters:
    
    configs - list of configuration
  - ClickHouseConfig
```
public ClickHouseConfig(Map<ClickHouseOption,Serializable> options,
                        ClickHouseCredentials credentials,
                        ClickHouseNodeSelector nodeSelector,
                        Object metricRegistry)
```
    Default contructor.
    
    Parameters:
    
    options - generic options
    
    credentials - default credential
    
    nodeSelector - node selector
    
    metricRegistry - metric registry
- Method Detail
  - mergeOptions
```
protected static final Map<ClickHouseOption,Serializable> mergeOptions(List<ClickHouseConfig> list)
```
  - mergeCredentials
```
protected static final ClickHouseCredentials mergeCredentials(List<ClickHouseConfig> list)
```
  - mergeNodeSelector
```
protected static final ClickHouseNodeSelector mergeNodeSelector(List<ClickHouseConfig> list)
```
  - mergeMetricRegistry
```
protected static final Object mergeMetricRegistry(List<ClickHouseConfig> list)
```
  - toClientOptions
```
public static Map<ClickHouseOption,Serializable> toClientOptions(Map<?,?> props)
```
    Converts given key-value pairs to a mutable map of corresponding ClickHouseOption.
    
    Parameters:
    
    props - key-value pairs
    
    Returns:
    
    non-null mutable map of client options
  - isAsync
```
public boolean isAsync()
```
  - isAutoDiscovery
```
public boolean isAutoDiscovery()
```
  - getClientName
```
public String getClientName()
```
  - isResponseCompressed
```
public boolean isResponseCompressed()
```
    Checks if server response is compressed or not.
    
    Returns:
    
    true if server response is compressed; false otherwise
  - getResponseCompressAlgorithm
```
public ClickHouseCompression getResponseCompressAlgorithm()
```
    Gets server response compress algorithm. When isResponseCompressed() is false, this will return ClickHouseCompression.NONE.
    
    Returns:
    
    non-null compress algorithm
  - getResponseCompressLevel
```
public int getResponseCompressLevel()
```
    Gets input compress level. When isResponseCompressed() is false, this will return 0.
    
    Returns:
    
    compress level
  - isCompressServerResponse
```
@Deprecated
public boolean isCompressServerResponse()
```
    Deprecated.
    will be removed in v0.3.3, please use isResponseCompressed() instead
    
    Checks if server response should be compressed or not.
    
    Returns:
    
    true if server response is compressed; false otherwise
  - getCompressAlgorithmForServerResponse
```
@Deprecated
public ClickHouseCompression getCompressAlgorithmForServerResponse()
```
    Deprecated.
    will be removed in v0.3.3, please use getResponseCompressAlgorithm() instead
    
    Gets compress algorithm for server response.
    
    Returns:
    
    compress algorithm for server response
  - getCompressLevelForServerResponse
```
@Deprecated
public int getCompressLevelForServerResponse()
```
    Deprecated.
    will be removed in v0.3.3, please use getResponseCompressLevel() instead
    
    Gets compress level for server response.
    
    Returns:
    
    compress level
  - isRequestCompressed
```
public boolean isRequestCompressed()
```
    Checks if client's output, aka. client request, should be compressed or not.
    
    Returns:
    
    true if client request should be compressed; false otherwise
  - getRequestCompressAlgorithm
```
public ClickHouseCompression getRequestCompressAlgorithm()
```
    Gets input compress algorithm. When isRequestCompressed() is false, this will return ClickHouseCompression.NONE.
    
    Returns:
    
    non-null compress algorithm
  - getRequestCompressLevel
```
public int getRequestCompressLevel()
```
    Gets input compress level. When isRequestCompressed() is false, this will return 0.
    
    Returns:
    
    compress level
  - isDecompressClientRequet
```
@Deprecated
public boolean isDecompressClientRequet()
```
    Deprecated.
    will be removed in v0.3.3, please use isRequestCompressed() instead
    
    Checks if client request should be compressed or not.
    
    Returns:
    
    true if server needs to decompress client request; false otherwise
  - getDecompressAlgorithmForClientRequest
```
@Deprecated
public ClickHouseCompression getDecompressAlgorithmForClientRequest()
```
    Deprecated.
    will be removed in v0.3.3, please use getRequestCompressAlgorithm() instead
    
    Gets compress algorithm for client request.
    
    Returns:
    
    compress algorithm for client request
  - getDecompressLevelForClientRequest
```
@Deprecated
public int getDecompressLevelForClientRequest()
```
    Deprecated.
    will be removed in v0.3.3, please use getRequestCompressLevel() instead
    
    Gets compress level for client request.
    
    Returns:
    
    compress level
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
  - getDatabase
```
public String getDatabase()
```
  - getFormat
```
public ClickHouseFormat getFormat()
```
  - getNodeCheckInterval
```
public int getNodeCheckInterval()
```
  - getMaxBufferSize
```
public int getMaxBufferSize()
```
    Gets max buffer size in byte can be used for streaming.
    
    Returns:
    
    max buffer size in byte
  - getBufferSize
```
public int getBufferSize()
```
    Gets default buffer size in byte for both read and write.
    
    Returns:
    
    default buffer size in byte
  - getBufferQueueVariation
```
public int getBufferQueueVariation()
```
    Gets 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.
    
    Returns:
    
    variation
  - getReadBufferSize
```
public int getReadBufferSize()
```
    Gets read buffer size in byte.
    
    Returns:
    
    read buffer size in byte
  - getWriteBufferSize
```
public int getWriteBufferSize()
```
    Gets write buffer size in byte.
    
    Returns:
    
    write buffer size in byte
  - getRequestChunkSize
```
public int getRequestChunkSize()
```
    Gets request chunk size.
    
    Returns:
    
    request chunk size
  - getRequestBuffering
```
public ClickHouseBufferingMode getRequestBuffering()
```
    Gets request buffering mode.
    
    Returns:
    
    request buffering mode
  - getResponseBuffering
```
public ClickHouseBufferingMode getResponseBuffering()
```
    Gets response buffering mode.
    
    Returns:
    
    response buffering mode
  - getMaxExecutionTime
```
public int getMaxExecutionTime()
```
  - getMaxQueuedBuffers
```
public int getMaxQueuedBuffers()
```
  - getMaxQueuedRequests
```
public int getMaxQueuedRequests()
```
  - getMaxResultRows
```
public long getMaxResultRows()
```
  - getMaxThreadsPerClient
```
public int getMaxThreadsPerClient()
```
  - getFailover
```
public int getFailover()
```
  - getRetry
```
public int getRetry()
```
  - isRepeatOnSessionLock
```
public boolean isRepeatOnSessionLock()
```
  - isRetry
```
@Deprecated
public boolean isRetry()
```
    Deprecated.
    will be removed in v0.3.3, please use getRetry() instead
    
    Checks whether retry is enabled or not.
    
    Returns:
    
    true if retry is enabled; false otherwise
  - isReuseValueWrapper
```
public boolean isReuseValueWrapper()
```
  - hasServerInfo
```
public boolean hasServerInfo()
```
    Checks whether we got all server information(e.g. timezone and version).
    
    Returns:
    
    true if we got all server information; false otherwise
  - getServerTimeZone
```
public TimeZone getServerTimeZone()
```
  - getServerVersion
```
public ClickHouseVersion getServerVersion()
```
  - getSessionTimeout
```
public int getSessionTimeout()
```
  - isSessionCheck
```
public boolean isSessionCheck()
```
  - getSocketTimeout
```
public int getSocketTimeout()
```
  - isSsl
```
public boolean isSsl()
```
  - getSslMode
```
public ClickHouseSslMode getSslMode()
```
  - getSslRootCert
```
public String getSslRootCert()
```
  - getSslCert
```
public String getSslCert()
```
  - getSslKey
```
public String getSslKey()
```
  - getTransactionTimeout
```
public int getTransactionTimeout()
```
  - isUseBlockingQueue
```
public boolean isUseBlockingQueue()
```
  - isUseObjectsInArray
```
public boolean isUseObjectsInArray()
```
  - isUseNoProxy
```
public boolean isUseNoProxy()
```
  - isUseServerTimeZone
```
public boolean isUseServerTimeZone()
```
  - isUseServerTimeZoneForDates
```
public boolean isUseServerTimeZoneForDates()
```
  - getTimeZoneForDate
```
public TimeZone getTimeZoneForDate()
```
    Gets time zone for date values.
    
    Returns:
    
    time zone, could be null when use_server_time_zone_for_date is set to false.
  - getUseTimeZone
```
public TimeZone getUseTimeZone()
```
    Gets preferred time zone. When isUseServerTimeZone() is true, this returns same time zone as getServerTimeZone().
    
    Returns:
    
    non-null preferred time zone
  - getDefaultCredentials
```
public ClickHouseCredentials getDefaultCredentials()
```
  - getMetricRegistry
```
public Optional<Object> getMetricRegistry()
```
  - getNodeSelector
```
public ClickHouseNodeSelector getNodeSelector()
```
  - getPreferredProtocols
```
public List<ClickHouseProtocol> getPreferredProtocols()
```
  - getPreferredTags
```
public Set<String> getPreferredTags()
```
  - getAllOptions
```
public Map<ClickHouseOption,Serializable> getAllOptions()
```
  - getOption
```
public Serializable getOption(ClickHouseOption option)
```
  - getOption
```
public Serializable getOption(ClickHouseOption option,
                              ClickHouseConfig defaultConfig)
```
  - getOption
```
public Serializable getOption(ClickHouseOption option,
                              ClickHouseDefaults defaultValue)
```
  - hasOption
```
public boolean hasOption(ClickHouseOption option)
```
    Test whether a given option is configured or not.
    
    Parameters:
    
    option - option to test
    
    Returns:
    
    true if the option is configured; false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ClickHouseConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClickHouseConfig

ClickHouseConfig

ClickHouseConfig

Method Detail

mergeOptions

mergeCredentials

mergeNodeSelector

mergeMetricRegistry

toClientOptions

isAsync

isAutoDiscovery

getClientName

isResponseCompressed

getResponseCompressAlgorithm

getResponseCompressLevel

isCompressServerResponse

getCompressAlgorithmForServerResponse

getCompressLevelForServerResponse

isRequestCompressed

getRequestCompressAlgorithm

getRequestCompressLevel

isDecompressClientRequet

getDecompressAlgorithmForClientRequest

getDecompressLevelForClientRequest

getConnectionTimeout

getDatabase

getFormat

getNodeCheckInterval

getMaxBufferSize

getBufferSize

getBufferQueueVariation

getReadBufferSize

getWriteBufferSize

getRequestChunkSize

getRequestBuffering

getResponseBuffering

getMaxExecutionTime

getMaxQueuedBuffers

getMaxQueuedRequests

getMaxResultRows

getMaxThreadsPerClient

getFailover

getRetry

isRepeatOnSessionLock

isRetry

isReuseValueWrapper

hasServerInfo

getServerTimeZone

getServerVersion

getSessionTimeout

isSessionCheck

getSocketTimeout

isSsl

getSslMode

getSslRootCert

getSslCert

getSslKey

getTransactionTimeout

isUseBlockingQueue

isUseObjectsInArray

isUseNoProxy

isUseServerTimeZone

isUseServerTimeZoneForDates

getTimeZoneForDate

getUseTimeZone

getDefaultCredentials

getMetricRegistry

getNodeSelector

getPreferredProtocols

getPreferredTags

getAllOptions

getOption

getOption

getOption

hasOption