Package com.clickhouse.client

Class ClickHouseConfig

java.lang.Object

com.clickhouse.client.ClickHouseConfig

All Implemented Interfaces:

ClickHouseDataConfig, Serializable

public class ClickHouseConfig
extends Object
implements ClickHouseDataConfig

An immutable class holding client-specific options like ClickHouseCredentials and ClickHouseNodeSelector etc.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.clickhouse.data.ClickHouseDataConfig

ClickHouseDataConfig.Wrapped

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

Fields inherited from interface com.clickhouse.data.ClickHouseDataConfig

DEFAULT_ASYNC, DEFAULT_BUFFER_QUEUE_VARIATION, DEFAULT_BUFFER_SIZE, DEFAULT_BUFFERING_MODE, DEFAULT_COLUMN_RENAME_METHOD, DEFAULT_COMPRESS_LEVEL, DEFAULT_FORMAT, DEFAULT_MAX_BUFFER_SIZE, DEFAULT_MAX_MAPPER_CACHE, DEFAULT_MAX_QUEUED_BUFFERS, DEFAULT_READ_BUFFER_SIZE, DEFAULT_READ_COMPRESS_LEVEL, DEFAULT_REUSE_VALUE_WRAPPER, DEFAULT_ROUNDING_MODE, DEFAULT_TIMEOUT, DEFAULT_USE_BINARY_STRING, DEFAULT_USE_BLOCKING_QUEUE, DEFAULT_USE_COMPILATION, DEFAULT_USE_OBJECT_IN_ARRAY, DEFAULT_WIDEN_UNSIGNED_TYPE, DEFAULT_WRITE_BUFFER_SIZE, DEFAULT_WRITE_COMPRESS_LEVEL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Map<ClickHouseOption,Serializable>	getAllOptions()
boolean	getBoolOption(ClickHouseOption option)	Shortcut of getOption(option, Boolean.class).
int	getBufferQueueVariation()
int	getBufferSize()
final String	getClientHost()	Same as ClickHouseClientOption.CLIENT_HOST.
final String	getClientJvmInfo()	Same as ClickHouseClientOption.CLIENT_JVM_INFO.
String	getClientName()
final String	getClientOsInfo()	Same as ClickHouseClientOption.CLIENT_OS_INFO.
final String	getClientUser()	Same as ClickHouseClientOption.CLIENT_USER.
ClickHouseRenameMethod	getColumnRenameMethod()
int	getConnectionTimeout()
Map<String,String>	getCustomSettings()
String	getCustomSocketFactory()
Map<String,String>	getCustomSocketFactoryOptions()
String	getDatabase()
ClickHouseCredentials	getDefaultCredentials()
int	getFailover()
ClickHouseFormat	getFormat()
int	getIntOption(ClickHouseOption option)	Shortcut of getOption(option, Integer.class).
String	getKeyStoreType()
long	getLongOption(ClickHouseOption option)	Shortcut of getOption(option, Long.class).
int	getMaxBufferSize()
int	getMaxExecutionTime()
int	getMaxMapperCache()
int	getMaxQueuedBuffers()
int	getMaxQueuedRequests()
long	getMaxResultRows()
int	getMaxThreadsPerClient()
Optional<Object>	getMetricRegistry()
int	getNodeCheckInterval()
ClickHouseNodeSelector	getNodeSelector()
Serializable	getOption(ClickHouseOption option)	Shortcut of getOption(ClickHouseOption, ClickHouseDefaults).
Serializable	getOption(ClickHouseOption option, ClickHouseConfig defaultConfig)	Gets option value.
Serializable	getOption(ClickHouseOption option, ClickHouseDefaults defaultValue)	Gets option value.
<T extends Serializable> T	getOption(ClickHouseOption option, Class<T> valueType)	Gets typed option value.
List<ClickHouseProtocol>	getPreferredProtocols()
Set<String>	getPreferredTags()
String	getProductName()
final String	getProductRevision()	Same as ClickHouseClientOption.PRODUCT_REVISION.
final String	getProductVersion()	Same as ClickHouseClientOption.PRODUCT_VERSION.
String	getProxyHost()
char[]	getProxyPassword()
int	getProxyPort()
ClickHouseProxyType	getProxyType()
String	getProxyUserName()
ClickHouseBufferingMode	getReadBufferingMode()
int	getReadBufferSize()
int	getReadTimeout()
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()
String	getStrOption(ClickHouseOption option)	Shortcut of getOption(option, String.class).
TimeZone	getTimeZoneForDate()	Gets time zone for date values.
int	getTransactionTimeout()
String	getTrustStore()
String	getTrustStorePassword()
TimeZone	getUseTimeZone()	Gets preferred time zone.
ClickHouseBufferingMode	getWriteBufferingMode()
int	getWriteBufferSize()
int	getWriteTimeout()
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	isRepeatOnSessionLock()
boolean	isRequestCompressed()	Checks if client's output, aka.
boolean	isResponseCompressed()	Checks if server response is compressed or not.
boolean	isReuseValueWrapper()
boolean	isSessionCheck()
boolean	isSsl()
boolean	isUseBinaryString()
boolean	isUseBlockingQueue()
boolean	isUseCompilation()
boolean	isUseObjectsInArray()
boolean	isUseServerTimeZone()
boolean	isUseServerTimeZoneForDates()
boolean	isWidenUnsignedTypes()
protected static final ClickHouseCredentials	mergeCredentials(List<ClickHouseConfig> list)
protected static final Object	mergeMetricRegistry(List<ClickHouseConfig> list)
protected static final ClickHouseNodeSelector	mergeNodeSelector(List<ClickHouseConfig> list)
protected static final 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

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

ClickHouseConfig

public ClickHouseConfig(ClickHouseConfig... configs)

Construct a new configuration by consolidating given ones.

Parameters:

configs - list of configuration

ClickHouseConfig

public ClickHouseConfig(List<ClickHouseConfig> configs)

Constructs a new configuration by consolidating given ones.

Parameters:

configs - list of configuration

ClickHouseConfig

public ClickHouseConfig(Map<ClickHouseOption,Serializable> options)

Constructs a new configuration using given options.

Parameters:

options - generic options

ClickHouseConfig

public ClickHouseConfig(Map<ClickHouseOption,Serializable> options,
 ClickHouseCredentials credentials,
 ClickHouseNodeSelector nodeSelector,
 Object metricRegistry)

Constructs a new configuration using given arguments.

Parameters:

options - generic options

credentials - default credential

nodeSelector - node selector

metricRegistry - metric registry

Method Details

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

Specified by:

isAsync in interface ClickHouseDataConfig

isAutoDiscovery

public boolean isAutoDiscovery()

getCustomSettings

public Map<String,String> getCustomSettings()

getCustomSocketFactory

public String getCustomSocketFactory()

getCustomSocketFactoryOptions

public Map<String,String> getCustomSocketFactoryOptions()

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 -1.

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 -1.

Returns:

compress level

getConnectionTimeout

public int getConnectionTimeout()

getDatabase

public String getDatabase()

getFormat

public ClickHouseFormat getFormat()

Specified by:

getFormat in interface ClickHouseDataConfig

getNodeCheckInterval

public int getNodeCheckInterval()

getMaxBufferSize

public int getMaxBufferSize()

Specified by:

getMaxBufferSize in interface ClickHouseDataConfig

getMaxMapperCache

public int getMaxMapperCache()

Specified by:

getMaxMapperCache in interface ClickHouseDataConfig

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ClickHouseDataConfig

getBufferQueueVariation

public int getBufferQueueVariation()

Specified by:

getBufferQueueVariation in interface ClickHouseDataConfig

getReadBufferSize

public int getReadBufferSize()

Specified by:

getReadBufferSize in interface ClickHouseDataConfig

getWriteBufferSize

public int getWriteBufferSize()

Specified by:

getWriteBufferSize in interface ClickHouseDataConfig

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

Specified by:

getMaxQueuedBuffers in interface ClickHouseDataConfig

getMaxQueuedRequests

public int getMaxQueuedRequests()

getMaxResultRows

public long getMaxResultRows()

getMaxThreadsPerClient

public int getMaxThreadsPerClient()

getProductName

public String getProductName()

getFailover

public int getFailover()

getRetry

public int getRetry()

isRepeatOnSessionLock

public boolean isRepeatOnSessionLock()

isReuseValueWrapper

public boolean isReuseValueWrapper()

Specified by:

isReuseValueWrapper in interface ClickHouseDataConfig

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

getKeyStoreType

public String getKeyStoreType()

getTrustStore

public String getTrustStore()

getTrustStorePassword

public String getTrustStorePassword()

getTransactionTimeout

public int getTransactionTimeout()

isWidenUnsignedTypes

public boolean isWidenUnsignedTypes()

Specified by:

isWidenUnsignedTypes in interface ClickHouseDataConfig

isUseBinaryString

public boolean isUseBinaryString()

Specified by:

isUseBinaryString in interface ClickHouseDataConfig

isUseBlockingQueue

public boolean isUseBlockingQueue()

Specified by:

isUseBlockingQueue in interface ClickHouseDataConfig

isUseCompilation

public boolean isUseCompilation()

Specified by:

isUseCompilation in interface ClickHouseDataConfig

isUseObjectsInArray

public boolean isUseObjectsInArray()

Specified by:

isUseObjectsInArray in interface ClickHouseDataConfig

getProxyType

public ClickHouseProxyType getProxyType()

getProxyHost

public String getProxyHost()

getProxyPort

public int getProxyPort()

getProxyUserName

public String getProxyUserName()

getProxyPassword

public char[] getProxyPassword()

isUseServerTimeZone

public boolean isUseServerTimeZone()

isUseServerTimeZoneForDates

public boolean isUseServerTimeZoneForDates()

getTimeZoneForDate

public TimeZone getTimeZoneForDate()

Gets time zone for date values.

Specified by:

getTimeZoneForDate in interface ClickHouseDataConfig

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

Specified by:

getUseTimeZone in interface ClickHouseDataConfig

Returns:

non-null preferred time zone

getProductVersion

public final String getProductVersion()

Same as ClickHouseClientOption.PRODUCT_VERSION.

Returns:

non-empty semantic version

getProductRevision

public final String getProductRevision()

Same as ClickHouseClientOption.PRODUCT_REVISION.

Returns:

non-empty revision

getClientOsInfo

public final String getClientOsInfo()

Same as ClickHouseClientOption.CLIENT_OS_INFO.

Returns:

non-empty O/S information

getClientJvmInfo

public final String getClientJvmInfo()

Same as ClickHouseClientOption.CLIENT_JVM_INFO.

Returns:

non-empty JVM information

getClientUser

public final String getClientUser()

Same as ClickHouseClientOption.CLIENT_USER.

Returns:

non-empty user name

getClientHost

public final String getClientHost()

Same as ClickHouseClientOption.CLIENT_HOST.

Returns:

non-empty host name

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 <T extends Serializable> T getOption(ClickHouseOption option,
 Class<T> valueType)

Gets typed option value. ClickHouseOption.getEffectiveDefaultValue() will be called when the option is undefined.

Type Parameters:

T - type of option value, must be serializable

Parameters:

option - non-null option to lookup

valueType - non-null type of option value, must be serializable

Returns:

typed value

getOption

public Serializable getOption(ClickHouseOption option,
 ClickHouseConfig defaultConfig)

Gets option value.

Parameters:

option - non-null option to lookup

defaultConfig - optional default config to retrieve default value

Returns:

option value

getOption

public Serializable getOption(ClickHouseOption option,
 ClickHouseDefaults defaultValue)

Gets option value.

Parameters:

option - non-null option to lookup

defaultValue - optional default value

Returns:

option value

getOption

public Serializable getOption(ClickHouseOption option)

Shortcut of getOption(ClickHouseOption, ClickHouseDefaults).

Parameters:

option - non-null option to lookup

Returns:

option value

getBoolOption

public boolean getBoolOption(ClickHouseOption option)

Shortcut of getOption(option, Boolean.class).

Parameters:

option - non-null option to lookup

Returns:

boolean value of the given option

getIntOption

public int getIntOption(ClickHouseOption option)

Shortcut of getOption(option, Integer.class).

Parameters:

option - non-null option to lookup

Returns:

int value of the given option

getLongOption

public long getLongOption(ClickHouseOption option)

Shortcut of getOption(option, Long.class).

Parameters:

option - non-null option to lookup

Returns:

long value of the given option

getStrOption

public String getStrOption(ClickHouseOption option)

Shortcut of getOption(option, String.class).

Parameters:

option - non-null option to lookup

Returns:

String value of the given option

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

getReadTimeout

public int getReadTimeout()

Specified by:

getReadTimeout in interface ClickHouseDataConfig

getWriteTimeout

public int getWriteTimeout()

Specified by:

getWriteTimeout in interface ClickHouseDataConfig

getReadBufferingMode

public ClickHouseBufferingMode getReadBufferingMode()

Specified by:

getReadBufferingMode in interface ClickHouseDataConfig

getWriteBufferingMode

public ClickHouseBufferingMode getWriteBufferingMode()

Specified by:

getWriteBufferingMode in interface ClickHouseDataConfig

getColumnRenameMethod

public ClickHouseRenameMethod getColumnRenameMethod()

Specified by:

getColumnRenameMethod in interface ClickHouseDataConfig