Package com.clickhouse.client.api

Enum ClientConfigProperties

java.lang.Object

java.lang.Enum<ClientConfigProperties>

com.clickhouse.client.api.ClientConfigProperties

All Implemented Interfaces:

Serializable, Comparable<ClientConfigProperties>, java.lang.constant.Constable

public enum ClientConfigProperties
extends Enum<ClientConfigProperties>

Enumerates all client properties that are known at release.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCESS_TOKEN
APP_COMPRESSED_DATA	Indicates that data provided for write operation is compressed by application.
ASYNC_OPERATIONS
BEARERTOKEN_AUTH
BINARY_READER_USE_PREALLOCATED_BUFFERS
CA_CERTIFICATE
CLIENT_NAME
CLIENT_NETWORK_BUFFER_SIZE
CLIENT_RETRY_ON_FAILURE
COMPRESS_CLIENT_REQUEST
COMPRESS_SERVER_RESPONSE
COMPRESSION_LZ4_UNCOMPRESSED_BUF_SIZE
CONNECTION_POOL_ENABLED
CONNECTION_REQUEST_TIMEOUT
CONNECTION_REUSE_STRATEGY
CONNECTION_TIMEOUT
CONNECTION_TTL
DATABASE
DISABLE_NATIVE_COMPRESSION
HTTP_KEEP_ALIVE_TIMEOUT	HTTP keep-alive timeout override.
HTTP_MAX_OPEN_CONNECTIONS	Maximum number of active connection in internal connection pool.
HTTP_SAVE_COOKIES
HTTP_USE_BASIC_AUTH
INPUT_OUTPUT_FORMAT
MAX_EXECUTION_TIME
MAX_THREADS_PER_CLIENT
METRICS_GROUP_NAME	Name of the group under which client metrics appear
PASSWORD
PRODUCT_NAME	Deprecated.
PROXY_HOST
PROXY_PASSWORD
PROXY_PORT
PROXY_TYPE
PROXY_USER
QUERY_ID
RETRY_ON_FAILURE
SERVER_TIMEZONE
SERVER_VERSION
SESSION_DB_ROLES
SETTING_LOG_COMMENT
SOCKET_KEEPALIVE_OPT
SOCKET_LINGER_OPT
SOCKET_OPERATION_TIMEOUT
SOCKET_RCVBUF_OPT
SOCKET_REUSEADDR_OPT
SOCKET_SNDBUF_OPT
SOCKET_TCP_NO_DELAY_OPT
SSL_AUTH
SSL_CERTIFICATE
SSL_KEY
SSL_KEY_STORE
SSL_KEY_STORE_PASSWORD
SSL_KEYSTORE_TYPE
SSL_SOCKET_SNI	SNI SSL parameter that will be set for each outbound SSL socket.
SSL_TRUST_STORE
TYPE_HINT_MAPPING	Defines mapping between ClickHouse data type and target Java type Used by binary readers to convert values into desired Java type.
USE_HTTP_COMPRESSION
USE_SERVER_TIMEZONE
USE_TIMEZONE
USER

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KEY
static final String	HTTP_HEADER_PREFIX
static final String	SERVER_SETTING_PREFIX

Method Summary

Modifier and Type	Method	Description
<T> void	applyIfSet(Map<String,Object> configMap, Consumer<T> consumer)
static String	commaSeparated(Collection<?> values)
String	getDefaultValue()
<T> T	getDefObjVal()
String	getKey()
<T> T	getOrDefault(Map<String,Object> configMap)
static String	httpHeader(String key)
static String	mapToString(Map<?,?> map, Function<Object,String> valueConverter)
static Map<String,Object>	parseConfigMap(Map<String,String> configMap)
Object	parseValue(String value)
static String	serverSetting(String key)
static Map<String,String>	toKeyValuePairs(String str)	Converts given string to key value pairs.
static Map<ClickHouseDataType,Class<?>>	translateTypeHintMapping(String mappingStr)
static ClientConfigProperties	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClientConfigProperties[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
static List<String>	valuesFromCommaSeparated(String value)

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SESSION_DB_ROLES

public static final ClientConfigProperties SESSION_DB_ROLES

SETTING_LOG_COMMENT

public static final ClientConfigProperties SETTING_LOG_COMMENT

HTTP_USE_BASIC_AUTH

public static final ClientConfigProperties HTTP_USE_BASIC_AUTH

USER

public static final ClientConfigProperties USER

PASSWORD

public static final ClientConfigProperties PASSWORD

HTTP_MAX_OPEN_CONNECTIONS

public static final ClientConfigProperties HTTP_MAX_OPEN_CONNECTIONS

Maximum number of active connection in internal connection pool.

HTTP_KEEP_ALIVE_TIMEOUT

public static final ClientConfigProperties HTTP_KEEP_ALIVE_TIMEOUT

HTTP keep-alive timeout override.

USE_SERVER_TIMEZONE

public static final ClientConfigProperties USE_SERVER_TIMEZONE

USE_TIMEZONE

public static final ClientConfigProperties USE_TIMEZONE

SERVER_VERSION

public static final ClientConfigProperties SERVER_VERSION

SERVER_TIMEZONE

public static final ClientConfigProperties SERVER_TIMEZONE

ASYNC_OPERATIONS

public static final ClientConfigProperties ASYNC_OPERATIONS

CONNECTION_TTL

public static final ClientConfigProperties CONNECTION_TTL

CONNECTION_TIMEOUT

public static final ClientConfigProperties CONNECTION_TIMEOUT

CONNECTION_REUSE_STRATEGY

public static final ClientConfigProperties CONNECTION_REUSE_STRATEGY

SOCKET_OPERATION_TIMEOUT

public static final ClientConfigProperties SOCKET_OPERATION_TIMEOUT

SOCKET_RCVBUF_OPT

public static final ClientConfigProperties SOCKET_RCVBUF_OPT

SOCKET_SNDBUF_OPT

public static final ClientConfigProperties SOCKET_SNDBUF_OPT

SOCKET_REUSEADDR_OPT

public static final ClientConfigProperties SOCKET_REUSEADDR_OPT

SOCKET_KEEPALIVE_OPT

public static final ClientConfigProperties SOCKET_KEEPALIVE_OPT

SOCKET_TCP_NO_DELAY_OPT

public static final ClientConfigProperties SOCKET_TCP_NO_DELAY_OPT

SOCKET_LINGER_OPT

public static final ClientConfigProperties SOCKET_LINGER_OPT

DATABASE

public static final ClientConfigProperties DATABASE

COMPRESS_SERVER_RESPONSE

public static final ClientConfigProperties COMPRESS_SERVER_RESPONSE

COMPRESS_CLIENT_REQUEST

public static final ClientConfigProperties COMPRESS_CLIENT_REQUEST

USE_HTTP_COMPRESSION

public static final ClientConfigProperties USE_HTTP_COMPRESSION

COMPRESSION_LZ4_UNCOMPRESSED_BUF_SIZE

public static final ClientConfigProperties COMPRESSION_LZ4_UNCOMPRESSED_BUF_SIZE

DISABLE_NATIVE_COMPRESSION

public static final ClientConfigProperties DISABLE_NATIVE_COMPRESSION

PROXY_TYPE

public static final ClientConfigProperties PROXY_TYPE

PROXY_HOST

public static final ClientConfigProperties PROXY_HOST

PROXY_PORT

public static final ClientConfigProperties PROXY_PORT

PROXY_USER

public static final ClientConfigProperties PROXY_USER

PROXY_PASSWORD

public static final ClientConfigProperties PROXY_PASSWORD

MAX_EXECUTION_TIME

public static final ClientConfigProperties MAX_EXECUTION_TIME

SSL_TRUST_STORE

public static final ClientConfigProperties SSL_TRUST_STORE

SSL_KEYSTORE_TYPE

public static final ClientConfigProperties SSL_KEYSTORE_TYPE

SSL_KEY_STORE

public static final ClientConfigProperties SSL_KEY_STORE

SSL_KEY_STORE_PASSWORD

public static final ClientConfigProperties SSL_KEY_STORE_PASSWORD

SSL_KEY

public static final ClientConfigProperties SSL_KEY

CA_CERTIFICATE

public static final ClientConfigProperties CA_CERTIFICATE

SSL_CERTIFICATE

public static final ClientConfigProperties SSL_CERTIFICATE

RETRY_ON_FAILURE

public static final ClientConfigProperties RETRY_ON_FAILURE

INPUT_OUTPUT_FORMAT

public static final ClientConfigProperties INPUT_OUTPUT_FORMAT

MAX_THREADS_PER_CLIENT

public static final ClientConfigProperties MAX_THREADS_PER_CLIENT

QUERY_ID

public static final ClientConfigProperties QUERY_ID

CLIENT_NETWORK_BUFFER_SIZE

public static final ClientConfigProperties CLIENT_NETWORK_BUFFER_SIZE

ACCESS_TOKEN

public static final ClientConfigProperties ACCESS_TOKEN

SSL_AUTH

public static final ClientConfigProperties SSL_AUTH

CONNECTION_POOL_ENABLED

public static final ClientConfigProperties CONNECTION_POOL_ENABLED

CONNECTION_REQUEST_TIMEOUT

public static final ClientConfigProperties CONNECTION_REQUEST_TIMEOUT

CLIENT_RETRY_ON_FAILURE

public static final ClientConfigProperties CLIENT_RETRY_ON_FAILURE

CLIENT_NAME

public static final ClientConfigProperties CLIENT_NAME

PRODUCT_NAME

@Deprecated
public static final ClientConfigProperties PRODUCT_NAME

Deprecated.

An old alias to CLIENT_NAME. Using the last one is preferred.

BEARERTOKEN_AUTH

public static final ClientConfigProperties BEARERTOKEN_AUTH

APP_COMPRESSED_DATA

public static final ClientConfigProperties APP_COMPRESSED_DATA

Indicates that data provided for write operation is compressed by application.

METRICS_GROUP_NAME

public static final ClientConfigProperties METRICS_GROUP_NAME

Name of the group under which client metrics appear

HTTP_SAVE_COOKIES

public static final ClientConfigProperties HTTP_SAVE_COOKIES

BINARY_READER_USE_PREALLOCATED_BUFFERS

public static final ClientConfigProperties BINARY_READER_USE_PREALLOCATED_BUFFERS

TYPE_HINT_MAPPING

public static final ClientConfigProperties TYPE_HINT_MAPPING

Defines mapping between ClickHouse data type and target Java type Used by binary readers to convert values into desired Java type.

SSL_SOCKET_SNI

public static final ClientConfigProperties SSL_SOCKET_SNI

SNI SSL parameter that will be set for each outbound SSL socket.

Field Details

HTTP_HEADER_PREFIX

public static final String HTTP_HEADER_PREFIX

See Also:

• Constant Field Values

SERVER_SETTING_PREFIX

public static final String SERVER_SETTING_PREFIX

See Also:

• Constant Field Values

DEFAULT_KEY

public static final String DEFAULT_KEY

See Also:

• Constant Field Values

Method Details

values

public static ClientConfigProperties[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientConfigProperties 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

getKey

public String getKey()

getDefaultValue

public String getDefaultValue()

getDefObjVal

public <T> T getDefObjVal()

serverSetting

public static String serverSetting(String key)

httpHeader

public static String httpHeader(String key)

commaSeparated

public static String commaSeparated(Collection<?> values)

valuesFromCommaSeparated

public static List<String> valuesFromCommaSeparated(String value)

parseValue

public Object parseValue(String value)

getOrDefault

public <T> T getOrDefault(Map<String,Object> configMap)

applyIfSet

public <T> void applyIfSet(Map<String,Object> configMap,
 Consumer<T> consumer)

parseConfigMap

public static Map<String,Object> parseConfigMap(Map<String,String> configMap)

toKeyValuePairs

public static Map<String,String> toKeyValuePairs(String str)

Converts given string to key value pairs. This is very simple implementation that do not handle edge cases like k1=v1, ,k2=v2

Parameters:

str - string

Returns:

non-null key value pairs

mapToString

public static String mapToString(Map<?,?> map,
 Function<Object,String> valueConverter)

translateTypeHintMapping

public static Map<ClickHouseDataType,Class<?>> translateTypeHintMapping(String mappingStr)