Package com.clickhouse.client

Class ClickHouseConfig

java.lang.Object
com.clickhouse.client.ClickHouseConfig
All Implemented Interfaces:
ClickHouseDataConfig, Serializable
@Deprecated public class ClickHouseConfig extends Object implements ClickHouseDataConfig
Deprecated.
An immutable class holding client-specific options like ClickHouseCredentials and ClickHouseNodeSelector etc.
See Also:

  • Field Details

  • Constructor Details

    • ClickHouseConfig

      public ClickHouseConfig(ClickHouseConfig... configs)
      Deprecated.
      Construct a new configuration by consolidating given ones.
      Parameters:
      configs - list of configuration

    • ClickHouseConfig

      public ClickHouseConfig(List<ClickHouseConfig> configs)
      Deprecated.
      Constructs a new configuration by consolidating given ones.
      Parameters:
      configs - list of configuration

    • ClickHouseConfig

      public ClickHouseConfig(Map<ClickHouseOption,Serializable> options)
      Deprecated.
      Constructs a new configuration using given options.
      Parameters:
      options - generic options

    • ClickHouseConfig

      public ClickHouseConfig(Map<ClickHouseOption,Serializable> options, ClickHouseCredentials credentials, ClickHouseNodeSelector nodeSelector, Object metricRegistry)
      Deprecated.
      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)
      Deprecated.

    • mergeCredentials

      protected static final ClickHouseCredentials mergeCredentials(List<ClickHouseConfig> list)
      Deprecated.

    • mergeNodeSelector

      protected static final ClickHouseNodeSelector mergeNodeSelector(List<ClickHouseConfig> list)
      Deprecated.

    • mergeMetricRegistry

      protected static final Object mergeMetricRegistry(List<ClickHouseConfig> list)
      Deprecated.

    • toClientOptions

      public static Map<ClickHouseOption,Serializable> toClientOptions(Map<?,?> props)
      Deprecated.
      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()
      Deprecated.
      Specified by:
      isAsync in interface ClickHouseDataConfig

    • isAutoDiscovery

      public boolean isAutoDiscovery()
      Deprecated.

    • getCustomSettings

      public Map<String,String> getCustomSettings()
      Deprecated.

    • getCustomSocketFactory

      public String getCustomSocketFactory()
      Deprecated.

    • getCustomSocketFactoryOptions

      public Map<String,String> getCustomSocketFactoryOptions()
      Deprecated.

    • getClientName

      public String getClientName()
      Deprecated.

    • isResponseCompressed

      public boolean isResponseCompressed()
      Deprecated.
      Checks if server response is compressed or not.
      Returns:
      true if server response is compressed; false otherwise

    • getResponseCompressAlgorithm

      public ClickHouseCompression getResponseCompressAlgorithm()
      Deprecated.
      Gets server response compress algorithm. When isResponseCompressed() is false, this will return ClickHouseCompression.NONE.
      Returns:
      non-null compress algorithm

    • getResponseCompressLevel

      public int getResponseCompressLevel()
      Deprecated.
      Gets input compress level. When isResponseCompressed() is false, this will return -1.
      Returns:
      compress level

    • isRequestCompressed

      public boolean isRequestCompressed()
      Deprecated.
      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()
      Deprecated.
      Gets input compress algorithm. When isRequestCompressed() is false, this will return ClickHouseCompression.NONE.
      Returns:
      non-null compress algorithm

    • getRequestCompressLevel

      public int getRequestCompressLevel()
      Deprecated.
      Gets input compress level. When isRequestCompressed() is false, this will return -1.
      Returns:
      compress level

    • getConnectionTimeout

      public int getConnectionTimeout()
      Deprecated.

    • getDatabase

      public String getDatabase()
      Deprecated.

    • getFormat

      public ClickHouseFormat getFormat()
      Deprecated.
      Specified by:
      getFormat in interface ClickHouseDataConfig

    • getNodeCheckInterval

      public int getNodeCheckInterval()
      Deprecated.

    • getMaxBufferSize

      public int getMaxBufferSize()
      Deprecated.
      Specified by:
      getMaxBufferSize in interface ClickHouseDataConfig

    • getMaxMapperCache

      public int getMaxMapperCache()
      Deprecated.
      Specified by:
      getMaxMapperCache in interface ClickHouseDataConfig

    • getBufferSize

      public int getBufferSize()
      Deprecated.
      Specified by:
      getBufferSize in interface ClickHouseDataConfig

    • getBufferQueueVariation

      public int getBufferQueueVariation()
      Deprecated.
      Specified by:
      getBufferQueueVariation in interface ClickHouseDataConfig

    • getReadBufferSize

      public int getReadBufferSize()
      Deprecated.
      Specified by:
      getReadBufferSize in interface ClickHouseDataConfig

    • getWriteBufferSize

      public int getWriteBufferSize()
      Deprecated.
      Specified by:
      getWriteBufferSize in interface ClickHouseDataConfig

    • getRequestChunkSize

      public int getRequestChunkSize()
      Deprecated.
      Gets request chunk size.
      Returns:
      request chunk size

    • getRequestBuffering

      public ClickHouseBufferingMode getRequestBuffering()
      Deprecated.
      Gets request buffering mode.
      Returns:
      request buffering mode

    • getResponseBuffering

      public ClickHouseBufferingMode getResponseBuffering()
      Deprecated.
      Gets response buffering mode.
      Returns:
      response buffering mode

    • getMaxExecutionTime

      public int getMaxExecutionTime()
      Deprecated.

    • getMaxQueuedBuffers

      public int getMaxQueuedBuffers()
      Deprecated.
      Specified by:
      getMaxQueuedBuffers in interface ClickHouseDataConfig

    • getMaxQueuedRequests

      public int getMaxQueuedRequests()
      Deprecated.

    • getMaxResultRows

      public long getMaxResultRows()
      Deprecated.

    • getMaxThreadsPerClient

      public int getMaxThreadsPerClient()
      Deprecated.

    • getProductName

      public String getProductName()
      Deprecated.

    • getFailover

      public int getFailover()
      Deprecated.

    • getRetry

      public int getRetry()
      Deprecated.

    • isRepeatOnSessionLock

      public boolean isRepeatOnSessionLock()
      Deprecated.

    • isReuseValueWrapper

      public boolean isReuseValueWrapper()
      Deprecated.
      Specified by:
      isReuseValueWrapper in interface ClickHouseDataConfig

    • hasServerInfo

      public boolean hasServerInfo()
      Deprecated.
      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()
      Deprecated.

    • getServerVersion

      public ClickHouseVersion getServerVersion()
      Deprecated.

    • getSessionTimeout

      public int getSessionTimeout()
      Deprecated.

    • isSessionCheck

      public boolean isSessionCheck()
      Deprecated.

    • getSocketTimeout

      public int getSocketTimeout()
      Deprecated.

    • isSsl

      public boolean isSsl()
      Deprecated.

    • getSslMode

      public ClickHouseSslMode getSslMode()
      Deprecated.

    • getSslRootCert

      public String getSslRootCert()
      Deprecated.

    • getSslCert

      public String getSslCert()
      Deprecated.

    • getSslKey

      public String getSslKey()
      Deprecated.

    • getKeyStoreType

      public String getKeyStoreType()
      Deprecated.

    • getTrustStore

      public String getTrustStore()
      Deprecated.

    • getTrustStorePassword

      public String getTrustStorePassword()
      Deprecated.

    • getTransactionTimeout

      public int getTransactionTimeout()
      Deprecated.

    • isWidenUnsignedTypes

      public boolean isWidenUnsignedTypes()
      Deprecated.
      Specified by:
      isWidenUnsignedTypes in interface ClickHouseDataConfig

    • isUseBinaryString

      public boolean isUseBinaryString()
      Deprecated.
      Specified by:
      isUseBinaryString in interface ClickHouseDataConfig

    • isUseBlockingQueue

      public boolean isUseBlockingQueue()
      Deprecated.
      Specified by:
      isUseBlockingQueue in interface ClickHouseDataConfig

    • isUseCompilation

      public boolean isUseCompilation()
      Deprecated.
      Specified by:
      isUseCompilation in interface ClickHouseDataConfig

    • isUseObjectsInArray

      public boolean isUseObjectsInArray()
      Deprecated.
      Specified by:
      isUseObjectsInArray in interface ClickHouseDataConfig

    • getProxyType

      public ClickHouseProxyType getProxyType()
      Deprecated.

    • getProxyHost

      public String getProxyHost()
      Deprecated.

    • getProxyPort

      public int getProxyPort()
      Deprecated.

    • getProxyUserName

      public String getProxyUserName()
      Deprecated.

    • getProxyPassword

      public char[] getProxyPassword()
      Deprecated.

    • isUseServerTimeZone

      public boolean isUseServerTimeZone()
      Deprecated.

    • isUseServerTimeZoneForDates

      public boolean isUseServerTimeZoneForDates()
      Deprecated.

    • getTimeZoneForDate

      public TimeZone getTimeZoneForDate()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      Same as ClickHouseClientOption.PRODUCT_VERSION.
      Returns:
      non-empty semantic version

    • getProductRevision

      public final String getProductRevision()
      Deprecated.
      Same as ClickHouseClientOption.PRODUCT_REVISION.
      Returns:
      non-empty revision

    • getClientOsInfo

      public final String getClientOsInfo()
      Deprecated.
      Same as ClickHouseClientOption.CLIENT_OS_INFO.
      Returns:
      non-empty O/S information

    • getClientJvmInfo

      public final String getClientJvmInfo()
      Deprecated.
      Same as ClickHouseClientOption.CLIENT_JVM_INFO.
      Returns:
      non-empty JVM information

    • getClientUser

      public final String getClientUser()
      Deprecated.
      Same as ClickHouseClientOption.CLIENT_USER.
      Returns:
      non-empty user name

    • getClientHost

      public final String getClientHost()
      Deprecated.
      Same as ClickHouseClientOption.CLIENT_HOST.
      Returns:
      non-empty host name

    • getDefaultCredentials

      public ClickHouseCredentials getDefaultCredentials()
      Deprecated.

    • getMetricRegistry

      public Optional<Object> getMetricRegistry()
      Deprecated.

    • getNodeSelector

      public ClickHouseNodeSelector getNodeSelector()
      Deprecated.

    • getPreferredProtocols

      public List<ClickHouseProtocol> getPreferredProtocols()
      Deprecated.

    • getPreferredTags

      public Set<String> getPreferredTags()
      Deprecated.

    • getAllOptions

      public Map<ClickHouseOption,Serializable> getAllOptions()
      Deprecated.

    • getOption

      public <T extends Serializable> T getOption(ClickHouseOption option, Class<T> valueType)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      Gets option value.
      Parameters:
      option - non-null option to lookup
      defaultValue - optional default value
      Returns:
      option value

    • getOption

      public Serializable getOption(ClickHouseOption option)
      Deprecated.
      Shortcut of getOption(ClickHouseOption, ClickHouseDefaults).
      Parameters:
      option - non-null option to lookup
      Returns:
      option value

    • getBoolOption

      public boolean getBoolOption(ClickHouseOption option)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Overrides:
      equals in class Object

    • getReadTimeout

      public int getReadTimeout()
      Deprecated.
      Specified by:
      getReadTimeout in interface ClickHouseDataConfig

    • getWriteTimeout

      public int getWriteTimeout()
      Deprecated.
      Specified by:
      getWriteTimeout in interface ClickHouseDataConfig

    • getReadBufferingMode

      public ClickHouseBufferingMode getReadBufferingMode()
      Deprecated.
      Specified by:
      getReadBufferingMode in interface ClickHouseDataConfig

    • getWriteBufferingMode

      public ClickHouseBufferingMode getWriteBufferingMode()
      Deprecated.
      Specified by:
      getWriteBufferingMode in interface ClickHouseDataConfig

    • getColumnRenameMethod

      public ClickHouseRenameMethod getColumnRenameMethod()
      Deprecated.
      Specified by:
      getColumnRenameMethod in interface ClickHouseDataConfig