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
Modifier and Type	Method	Description
`Map<ClickHouseOption,Serializable>`	`getAllOptions()`
`String`	`getClientName()`
`ClickHouseCompression`	`getCompressAlgorithmForServerResponse()`
`int`	`getCompressLevelForServerResponse()`
`int`	`getConnectionTimeout()`
`String`	`getDatabase()`
`ClickHouseCompression`	`getDecompressAlgorithmForClientRequest()`
`int`	`getDecompressLevelForClientRequest()`
`ClickHouseCredentials`	`getDefaultCredentials()`
`ClickHouseFormat`	`getFormat()`
`int`	`getMaxBufferSize()`
`int`	`getMaxExecutionTime()`
`int`	`getMaxQueuedBuffers()`
`int`	`getMaxQueuedRequests()`
`int`	`getMaxResultRows()`
`int`	`getMaxThreadsPerClient()`
`Optional<Object>`	`getMetricRegistry()`
`ClickHouseNodeSelector`	`getNodeSelector()`
`Serializable`	`getOption(ClickHouseOption option)`
`Serializable`	`getOption(ClickHouseOption option, ClickHouseDefaults defaultValue)`
`List<ClickHouseProtocol>`	`getPreferredProtocols()`
`Set<String>`	`getPreferredTags()`
`TimeZone`	`getServerTimeZone()`
`ClickHouseVersion`	`getServerVersion()`
`int`	`getSessionTimeout()`
`int`	`getSocketTimeout()`
`String`	`getSslCert()`
`String`	`getSslKey()`
`ClickHouseSslMode`	`getSslMode()`
`String`	`getSslRootCert()`
`TimeZone`	`getTimeZoneForDate()`	Gets time zone for date values.
`TimeZone`	`getUseTimeZone()`	Gets preferred time zone.
`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`	`isCompressServerResponse()`
`boolean`	`isDecompressClientRequet()`
`boolean`	`isRetry()`
`boolean`	`isReuseValueWrapper()`
`boolean`	`isSessionCheck()`
`boolean`	`isSsl()`
`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)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, 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)

isAsync
```
public boolean isAsync()
```

getClientName
```
public String getClientName()
```

isCompressServerResponse

public boolean isCompressServerResponse()

getCompressAlgorithmForServerResponse

public ClickHouseCompression getCompressAlgorithmForServerResponse()

getCompressLevelForServerResponse

public int getCompressLevelForServerResponse()

isDecompressClientRequet

public boolean isDecompressClientRequet()

getDecompressAlgorithmForClientRequest

public ClickHouseCompression getDecompressAlgorithmForClientRequest()

getDecompressLevelForClientRequest

public int getDecompressLevelForClientRequest()

getConnectionTimeout
```
public int getConnectionTimeout()
```

getDatabase
```
public String getDatabase()
```

getFormat
```
public ClickHouseFormat getFormat()
```

getMaxBufferSize
```
public int getMaxBufferSize()
```

getMaxExecutionTime
```
public int getMaxExecutionTime()
```

getMaxQueuedBuffers
```
public int getMaxQueuedBuffers()
```

getMaxQueuedRequests
```
public int getMaxQueuedRequests()
```

getMaxResultRows
```
public int getMaxResultRows()
```

getMaxThreadsPerClient
```
public int getMaxThreadsPerClient()
```

isRetry
```
public boolean isRetry()
```

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()
```

isUseObjectsInArray
```
public boolean isUseObjectsInArray()
```

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,
                              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

Class ClickHouseConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClickHouseConfig

ClickHouseConfig

ClickHouseConfig

Method Detail

mergeOptions

mergeCredentials

mergeNodeSelector

mergeMetricRegistry

isAsync

getClientName

isCompressServerResponse

getCompressAlgorithmForServerResponse

getCompressLevelForServerResponse

isDecompressClientRequet

getDecompressAlgorithmForClientRequest

getDecompressLevelForClientRequest

getConnectionTimeout

getDatabase

getFormat

getMaxBufferSize

getMaxExecutionTime

getMaxQueuedBuffers

getMaxQueuedRequests

getMaxResultRows

getMaxThreadsPerClient

isRetry

isReuseValueWrapper

hasServerInfo

getServerTimeZone

getServerVersion

getSessionTimeout

isSessionCheck

getSocketTimeout

isSsl

getSslMode

getSslRootCert

getSslCert

getSslKey

isUseObjectsInArray

isUseServerTimeZone

isUseServerTimeZoneForDates

getTimeZoneForDate

getUseTimeZone

getDefaultCredentials

getMetricRegistry

getNodeSelector

getPreferredProtocols

getPreferredTags

getAllOptions

getOption

getOption

hasOption