Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- abort() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Aborts the transaction.
- AbstractClient<T> - Class in com.clickhouse.client
-
Base class for implementing a thread-safe ClickHouse client.
- AbstractClient() - Constructor for class com.clickhouse.client.AbstractClient
- AbstractSocketClient - Class in com.clickhouse.client
- AbstractSocketClient() - Constructor for class com.clickhouse.client.AbstractSocketClient
- AbstractSocketClient(ClickHouseConfig) - Constructor for class com.clickhouse.client.AbstractSocketClient
- AbstractSocketClient(ClickHouseNode) - Constructor for class com.clickhouse.client.AbstractSocketClient
- accept(ClickHouseProtocol) - Method in class com.clickhouse.client.AbstractClient
- accept(ClickHouseProtocol) - Method in interface com.clickhouse.client.ClickHouseClient
-
Tests whether the given protocol is supported or not.
- ACTIVE - Static variable in class com.clickhouse.client.ClickHouseTransaction
- add(ClickHouseResponseSummary) - Method in class com.clickhouse.client.ClickHouseResponseSummary
- add(ClickHouseResponseSummary.Progress) - Method in class com.clickhouse.client.ClickHouseResponseSummary
- add(ClickHouseResponseSummary.Progress) - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- add(ClickHouseResponseSummary.Statistics) - Method in class com.clickhouse.client.ClickHouseResponseSummary
- add(ClickHouseResponseSummary.Statistics) - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- addExternal(ClickHouseExternalTable) - Method in class com.clickhouse.client.ClickHouseRequest
-
Adds an external table.
- addOption(String, String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Adds an option for this node.
- addPart(String, int, String) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Adds part of query and the following parameter.
- addPart(String, int, String, String) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Adds part of query and the following parameter.
- address(ClickHouseProtocol, InetSocketAddress) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets protocol and socket address.
- address(InetSocketAddress) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets socket address.
- addTag(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Adds a tag for this node.
- agent - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- agent(boolean) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets whether agent should be used for advanced feature like failover and retry.
- ANY - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
Protocol detection is needed when establishing connection.
- appendLastPartIfExists(StringBuilder) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Appends last part of the query if it exists.
- apply(ClickHouseNodeSelector) - Method in class com.clickhouse.client.ClickHouseNode
- apply(ClickHouseNodeSelector) - Method in class com.clickhouse.client.ClickHouseNodes
- apply(StringBuilder, Object[]) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies raw parameters to the given string builder.
- apply(StringBuilder, Object, Object...) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies raw parameters to the given string builder.
- apply(StringBuilder, String[]) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies stringified parameters to the given string builder.
- apply(StringBuilder, String, String...) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies stringified parameters to the given string builder.
- apply(StringBuilder, String, Map<String, String>) - Static method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Substitute named parameters in given SQL.
- apply(StringBuilder, Collection<String>) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies stringified parameters to the given string builder.
- apply(StringBuilder, Map<String, String>) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Applies stringified parameters to the given string builder.
- apply(String, Map<String, String>) - Static method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Substitute named parameters in given SQL.
- asTupleString() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- ASYNC - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether the client should run in async mode(e.g.
- ASYNC - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default execution mode.
- AUTO_DISCOVERY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether the client should discover more nodes from system tables and/or clickhouse-keeper/zookeeper.
- AUTO_SESSION - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Whether to create session automatically when there are multiple queries.
B
- begin() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Starts a new transaction.
- begin(Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Starts a new transaction with optional server settings.
- BUFFER_QUEUE_VARIATION - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Number of times the buffer queue is filled up before increasing capacity of buffer queue.
- BUFFER_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Default buffer size in byte for both request and response.
- BUFFERING - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default buffering mode.
- build() - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Builds an instance of
ClickHouseClient
. - build() - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Creates a new node.
- buildCacheKey(String, Map<?, ?>) - Static method in class com.clickhouse.client.ClickHouseNodes
-
Build unique key according to the given base URI and options for caching.
- builder() - Static method in interface com.clickhouse.client.ClickHouseClient
-
Returns a builder for creating a new client.
- builder() - Static method in class com.clickhouse.client.ClickHouseNode
-
Gets builder for creating a new node, same as
builder(null)
. - builder(ClickHouseNode) - Static method in class com.clickhouse.client.ClickHouseNode
-
Gets builder for creating a new node based on the given one.
- Builder() - Constructor for class com.clickhouse.client.ClickHouseNode.Builder
-
Default constructor.
- buildErrorMessage(int, String) - Static method in exception com.clickhouse.client.ClickHouseException
-
Builds error message like
"Code: <code>, <detail>"
. - buildUserAgent(String, String) - Static method in enum com.clickhouse.client.config.ClickHouseClientOption
-
Builds user-agent based on given product name.
C
- changeListener - Variable in class com.clickhouse.client.ClickHouseRequest
- changeProperty(String, T, T) - Method in class com.clickhouse.client.ClickHouseRequest
- changeServer(ClickHouseNode, ClickHouseNode) - Method in class com.clickhouse.client.ClickHouseRequest
- check() - Method in class com.clickhouse.client.ClickHouseNodes
-
Checks (faulty) node status.
- CHECK_ALL_NODES - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to perform health check against all nodes or just faulty ones.
- checkConnection(T, ClickHouseNode, ClickHouseNode, ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
-
Checks if the underlying connection can be reused.
- checkHealth(ClickHouseNode, int) - Method in class com.clickhouse.client.AbstractClient
- checking - Variable in class com.clickhouse.client.ClickHouseNodes
-
Flag for exclusive health check.
- checkSealed() - Method in class com.clickhouse.client.ClickHouseRequest
- clearOptions() - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Removes all options.
- clearSession() - Method in class com.clickhouse.client.ClickHouseRequest
-
Clears session configuration including session id, session check(whether to validate the id), and session timeout.
- clearSettings() - Method in class com.clickhouse.client.ClickHouseRequest
-
Clears server settings.
- ClickHouseClient - Interface in com.clickhouse.client
-
A unified interface defines Java client for ClickHouse.
- ClickHouseClientBuilder - Class in com.clickhouse.client
-
Builder class for creating
ClickHouseClient
. - ClickHouseClientBuilder() - Constructor for class com.clickhouse.client.ClickHouseClientBuilder
-
Default constructor.
- ClickHouseClientOption - Enum in com.clickhouse.client.config
-
Generic client options.
- ClickHouseCluster - Class in com.clickhouse.client
- ClickHouseCluster(String, Collection<ClickHouseNode>) - Constructor for class com.clickhouse.client.ClickHouseCluster
-
Constructs cluster object using policy and list of nodes.
- ClickHouseConfig - Class in com.clickhouse.client
-
An immutable class holding client-specific options like
ClickHouseCredentials
andClickHouseNodeSelector
etc. - ClickHouseConfig(ClickHouseConfig...) - Constructor for class com.clickhouse.client.ClickHouseConfig
-
Construct a new configuration by consolidating given ones.
- ClickHouseConfig(List<ClickHouseConfig>) - Constructor for class com.clickhouse.client.ClickHouseConfig
-
Constructs a new configuration by consolidating given ones.
- ClickHouseConfig(Map<ClickHouseOption, Serializable>) - Constructor for class com.clickhouse.client.ClickHouseConfig
-
Constructs a new configuration using given options.
- ClickHouseConfig(Map<ClickHouseOption, Serializable>, ClickHouseCredentials, ClickHouseNodeSelector, Object) - Constructor for class com.clickhouse.client.ClickHouseConfig
-
Constructs a new configuration using given arguments.
- ClickHouseCredentials - Class in com.clickhouse.client
-
This encapsulates access token, certificate or user name password combination for accessing ClickHouse.
- ClickHouseCredentials(String) - Constructor for class com.clickhouse.client.ClickHouseCredentials
-
Construct credentials object using access token.
- ClickHouseCredentials(String, String) - Constructor for class com.clickhouse.client.ClickHouseCredentials
-
Construct credentials using user name and password.
- ClickHouseDefaults - Enum in com.clickhouse.client.config
-
System-wide default options.
- ClickHouseDefaultSslContextProvider - Class in com.clickhouse.client.config
- ClickHouseDefaultSslContextProvider() - Constructor for class com.clickhouse.client.config.ClickHouseDefaultSslContextProvider
- ClickHouseDnsResolver - Class in com.clickhouse.client
-
Default DNS resolver.
- ClickHouseDnsResolver() - Constructor for class com.clickhouse.client.ClickHouseDnsResolver
- ClickHouseException - Exception in com.clickhouse.client
-
Exception thrown from ClickHouse server.
- ClickHouseException(int, String, ClickHouseNode) - Constructor for exception com.clickhouse.client.ClickHouseException
-
Constructs an exception without cause.
- ClickHouseException(int, String, Throwable) - Constructor for exception com.clickhouse.client.ClickHouseException
-
Constructs an exception.
- ClickHouseException(int, Throwable, ClickHouseNode) - Constructor for exception com.clickhouse.client.ClickHouseException
-
Constructs an exception with cause.
- ClickHouseHealthCheckMethod - Enum in com.clickhouse.client.config
- ClickHouseLoadBalancingPolicy - Class in com.clickhouse.client
-
Load balancing policy.
- ClickHouseLoadBalancingPolicy() - Constructor for class com.clickhouse.client.ClickHouseLoadBalancingPolicy
- ClickHouseNode - Class in com.clickhouse.client
-
This class depicts a ClickHouse server, essentially a combination of host, port and protocol, for client to connect.
- ClickHouseNode(ClickHouseNode.Builder) - Constructor for class com.clickhouse.client.ClickHouseNode
- ClickHouseNode(String, ClickHouseProtocol, int, ClickHouseCredentials, Map<String, String>, Set<String>) - Constructor for class com.clickhouse.client.ClickHouseNode
- ClickHouseNode.Builder - Class in com.clickhouse.client
-
Mutable and non-thread safe builder.
- ClickHouseNode.Status - Enum in com.clickhouse.client
-
Node status.
- ClickHouseNodeManager - Interface in com.clickhouse.client
-
Node manager is responsible for managing list of nodes and their status.
- ClickHouseNodes - Class in com.clickhouse.client
-
A generic node manager for managing one or more nodes which may or may not belong to same cluster.
- ClickHouseNodes(Collection<ClickHouseNode>, ClickHouseNode) - Constructor for class com.clickhouse.client.ClickHouseNodes
-
Default constructor.
- ClickHouseNodeSelector - Class in com.clickhouse.client
-
This class maintains two immutable collections: preferred protocols and tags.
- ClickHouseNodeSelector(Collection<ClickHouseProtocol>, Collection<String>) - Constructor for class com.clickhouse.client.ClickHouseNodeSelector
-
Default constructor.
- ClickHouseParameterizedQuery - Class in com.clickhouse.client
-
A parameterized query is a parsed query with parameters being extracted for substitution.
- ClickHouseParameterizedQuery(ClickHouseConfig, String) - Constructor for class com.clickhouse.client.ClickHouseParameterizedQuery
-
Default constructor.
- ClickHouseParameterizedQuery.QueryPart - Class in com.clickhouse.client
-
A part of query.
- ClickHouseProtocol - Enum in com.clickhouse.client
-
This defines protocols can be used to connect to ClickHouse.
- ClickHouseProxyType - Enum in com.clickhouse.client.config
-
Defines supported SSL mode.
- ClickHouseRequest<SelfT extends ClickHouseRequest<SelfT>> - Class in com.clickhouse.client
-
Request object holding references to
ClickHouseClient
,ClickHouseNode
, format, sql, options and settings etc. - ClickHouseRequest(ClickHouseClient, Function<ClickHouseNodeSelector, ClickHouseNode>, AtomicReference<ClickHouseNode>, Map<ClickHouseOption, Serializable>, boolean) - Constructor for class com.clickhouse.client.ClickHouseRequest
- ClickHouseRequest.Mutation - Class in com.clickhouse.client
-
Mutation request.
- ClickHouseRequestManager - Class in com.clickhouse.client
-
Request manager is responsible for generating query and session ID, as well as transaction creation.
- ClickHouseRequestManager() - Constructor for class com.clickhouse.client.ClickHouseRequestManager
- ClickHouseResponse - Interface in com.clickhouse.client
-
This encapsulates a server reponse.
- ClickHouseResponseSummary - Class in com.clickhouse.client
-
Summary of ClickHouse response.
- ClickHouseResponseSummary(ClickHouseResponseSummary.Progress, ClickHouseResponseSummary.Statistics) - Constructor for class com.clickhouse.client.ClickHouseResponseSummary
-
Default constructor.
- ClickHouseResponseSummary(ClickHouseResponseSummary.Progress, ClickHouseResponseSummary.Statistics, boolean) - Constructor for class com.clickhouse.client.ClickHouseResponseSummary
-
Default constructor.
- ClickHouseResponseSummary.Progress - Class in com.clickhouse.client
-
Progress of a query.
- ClickHouseResponseSummary.Statistics - Class in com.clickhouse.client
-
Statistics of a query.
- ClickHouseSimpleResponse - Class in com.clickhouse.client
-
A simple response built on top of two lists: columns and records.
- ClickHouseSimpleResponse(List<ClickHouseColumn>, ClickHouseValue[][], ClickHouseResponseSummary) - Constructor for class com.clickhouse.client.ClickHouseSimpleResponse
- ClickHouseSimpleResponse(List<ClickHouseColumn>, List<ClickHouseRecord>, ClickHouseResponseSummary) - Constructor for class com.clickhouse.client.ClickHouseSimpleResponse
- ClickHouseSocketFactory - Interface in com.clickhouse.client
-
Generic factory interface for creating sockets used by the TCP and Apache Http clients.
- ClickHouseSslContextProvider - Interface in com.clickhouse.client
-
This interface defines how to build SSL context based on given configuration and target server.
- ClickHouseSslMode - Enum in com.clickhouse.client.config
-
Defines supported SSL mode.
- ClickHouseStreamResponse - Class in com.clickhouse.client
-
A stream response from server.
- ClickHouseStreamResponse(ClickHouseConfig, ClickHouseInputStream, Map<String, Serializable>, List<ClickHouseColumn>, ClickHouseResponseSummary) - Constructor for class com.clickhouse.client.ClickHouseStreamResponse
- ClickHouseTransaction - Class in com.clickhouse.client
-
This class represents a transaction in ClickHouse.
- ClickHouseTransaction(ClickHouseNode, int, boolean) - Constructor for class com.clickhouse.client.ClickHouseTransaction
-
Constructs a unique transaction in
ClickHouseTransaction.ACTIVE
state. - ClickHouseTransaction(ClickHouseNode, String, int, ClickHouseTransaction.XID) - Constructor for class com.clickhouse.client.ClickHouseTransaction
-
Constructs a transaction in
ClickHouseTransaction.NEW
state, henceClickHouseTransaction.begin()
orClickHouseTransaction.begin(Map)
must be called before commit/rollback andClickHouseTransaction.isImplicit()
is alwaysfalse
. - ClickHouseTransaction.XID - Class in com.clickhouse.client
-
This class encapsulates transaction ID, which is defined as
Tuple(snapshotVersion UInt64, localTxCounter UInt64, hostId UUID)
. - ClickHouseTransactionException - Exception in com.clickhouse.client
- ClickHouseTransactionException(int, String, ClickHouseTransaction) - Constructor for exception com.clickhouse.client.ClickHouseTransactionException
- ClickHouseTransactionException(int, String, Throwable, ClickHouseTransaction) - Constructor for exception com.clickhouse.client.ClickHouseTransactionException
- ClickHouseTransactionException(String, ClickHouseTransaction) - Constructor for exception com.clickhouse.client.ClickHouseTransactionException
- ClickHouseTransactionException(String, Throwable, ClickHouseTransaction) - Constructor for exception com.clickhouse.client.ClickHouseTransactionException
- CLIENT_HOST - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Client host name.
- CLIENT_JVM_INFO - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Client JVM information in format of
<jvm name>/<jvm version>
. - CLIENT_NAME - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Client name.
- CLIENT_OS_INFO - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Client O/S information in format of
<o/s name>/<o/s version>
. - CLIENT_USER - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Client user name.
- close() - Method in class com.clickhouse.client.AbstractClient
- close() - Method in class com.clickhouse.client.AbstractSocketClient
- close() - Method in interface com.clickhouse.client.ClickHouseClient
- close() - Method in interface com.clickhouse.client.ClickHouseResponse
- close() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- close() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- closeConnection(T, boolean) - Method in class com.clickhouse.client.AbstractClient
-
Closes a connection.
- cluster(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets cluster name.
- com.clickhouse.client - package com.clickhouse.client
-
Provides necessary classes to communicate with ClickHouse server.
- com.clickhouse.client.config - package com.clickhouse.client.config
-
Provides necessary classes to configure the client and/or request.
- COMMAND_BEGIN - Static variable in class com.clickhouse.client.ClickHouseTransaction
- COMMAND_COMMIT - Static variable in class com.clickhouse.client.ClickHouseTransaction
- COMMAND_ROLLBACK - Static variable in class com.clickhouse.client.ClickHouseTransaction
- commit() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Commits the transaction.
- commit(Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Commits the transaction with optional server settings.
- COMMITTED - Static variable in class com.clickhouse.client.ClickHouseTransaction
- COMPRESS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether server will compress response to client or not.
- COMPRESS_ALGORITHM - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Compression algorithm server will use to compress response, when
ClickHouseClientOption.COMPRESS
istrue
. - COMPRESS_LEVEL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Compression level for compressing server response.
- compressServerResponse(boolean) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of server response.
- compressServerResponse(boolean, ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of server response.
- compressServerResponse(boolean, ClickHouseCompression, int) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of server response.
- compressServerResponse(ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of server response.
- config - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- config - Variable in class com.clickhouse.client.ClickHouseNode
- config - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery
- config - Variable in class com.clickhouse.client.ClickHouseRequest
- config - Variable in class com.clickhouse.client.ClickHouseStreamResponse
- config(ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets configuration.
- connect(ClickHouseNode) - Method in class com.clickhouse.client.AbstractSocketClient
- connect(InetSocketAddress) - Method in class com.clickhouse.client.AbstractSocketClient
- CONNECTION_TIMEOUT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Connection timeout in milliseconds.
- copy() - Method in class com.clickhouse.client.ClickHouseRequest
-
Creates a copy of this request including listeners.
- create(ClickHouseConfig, Class<T>) - Method in interface com.clickhouse.client.ClickHouseSocketFactory
-
Creates a new instance of the provided configuration and class type.
- createImplicitTransaction(ClickHouseRequest<?>) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates an implicit transaction.
- createQueryId() - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a new query ID.
- createSessionId() - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a new session ID.
- createTransaction(ClickHouseNode, int) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a new transaction.
- createTransaction(ClickHouseRequest<?>) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a new transaction.
- createTransaction(ClickHouseRequest<?>, int) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a new transaction.
- createUniqueId() - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Creates a global, URL-safe unique ID.
- credentials - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- credentials - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- credentials(ClickHouseCredentials) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets credentials will be used when connecting to this node.
- CSN_COMMITTING - Static variable in class com.clickhouse.client.ClickHouseTransaction
- CSN_EVERYTHING_VISIBLE - Static variable in class com.clickhouse.client.ClickHouseTransaction
- CSN_MAX_RESERVED - Static variable in class com.clickhouse.client.ClickHouseTransaction
- CSN_PREHISTORIC - Static variable in class com.clickhouse.client.ClickHouseTransaction
- CSN_UNKNOWN - Static variable in class com.clickhouse.client.ClickHouseTransaction
- CUSTOM_SETTINGS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Custom server settings for all queries.
- CUSTOM_SOCKET_FACTORY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Custom socket factory.
- CUSTOM_SOCKET_FACTORY_OPTIONS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Additional socket factory options.
D
- data(ClickHouseDeferredValue<ClickHouseInputStream>) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads data from deferred input stream.
- data(ClickHouseInputStream) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads data from input stream.
- data(ClickHousePassThruStream) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads data from the given pass-thru stream which may or may not be compressed.
- data(ClickHouseWriter) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Sets custom writer for writing uncompressed data, use
ClickHouseRequest.Mutation.data(ClickHousePassThruStream)
when the data is compressed. - data(InputStream) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads data from input stream.
- data(String) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads data from the given file.
- data(String, ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads compressed data from the given file.
- data(String, ClickHouseCompression, int) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
-
Loads compressed data from the given file.
- database(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets database name.
- DATABASE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Default database.
- DATABASE - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default database.
- DECOMPRESS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether server will decompress request from client or not.
- DECOMPRESS_ALGORITHM - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Compression algorithm server will use to decompress request, when
ClickHouseClientOption.DECOMPRESS
istrue
. - DECOMPRESS_LEVEL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Compression level for decompress client request.
- decompressClientRequest(boolean) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of client request.
- decompressClientRequest(boolean, ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of client request.
- decompressClientRequest(boolean, ClickHouseCompression, int) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of client request.
- decompressClientRequest(ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest
-
Enable or disable compression of client request.
- defaultCredentials(ClickHouseCredentials) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets default credentials, which will be used to connect to a
ClickHouseNode
only when it has no credentials defined. - defaultTypes - Static variable in class com.clickhouse.client.ClickHouseStreamResponse
- DIRECT - Enum constant in enum com.clickhouse.client.config.ClickHouseProxyType
- discover() - Method in class com.clickhouse.client.ClickHouseNodes
-
Discovers nodes in the same cluster by querying against
system.clusters
table. - discoveryFuture - Variable in class com.clickhouse.client.ClickHouseNodes
-
Reference holding future of scheduled discovery.
- dump(ClickHouseNode, String, ClickHousePassThruStream) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Dumps a table or query result from server into the given pass-thru stream.
- dump(ClickHouseNode, String, OutputStream, ClickHouseCompression, ClickHouseFormat) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Dumps a table or query result from server into output stream.
- dump(ClickHouseNode, String, String, ClickHouseCompression, ClickHouseFormat) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Dumps a table or query result from server into a file.
E
- EMPTY - Static variable in class com.clickhouse.client.ClickHouseNodeSelector
-
Empty node selector matches all clients and nodes.
- EMPTY - Static variable in interface com.clickhouse.client.ClickHouseResponse
-
Empty response that can never be closed.
- EMPTY - Static variable in class com.clickhouse.client.ClickHouseResponseSummary
- EMPTY - Static variable in class com.clickhouse.client.ClickHouseTransaction.XID
- ensureTransactionId() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Ensures client and server are using the exact same transaction ID.
- equals(Object) - Method in class com.clickhouse.client.ClickHouseCluster
- equals(Object) - Method in class com.clickhouse.client.ClickHouseConfig
- equals(Object) - Method in class com.clickhouse.client.ClickHouseCredentials
- equals(Object) - Method in class com.clickhouse.client.ClickHouseNode
- equals(Object) - Method in class com.clickhouse.client.ClickHouseNodes
- equals(Object) - Method in class com.clickhouse.client.ClickHouseNodeSelector
- equals(Object) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
- equals(Object) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- equals(Object) - Method in class com.clickhouse.client.ClickHouseTransaction
- equals(Object) - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- ERROR_ABORTED - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_CANCELLED - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_INVALID_INPUT_STREAM - Static variable in class com.clickhouse.client.AbstractSocketClient
- ERROR_INVALID_OUTPUT_STREAM - Static variable in class com.clickhouse.client.AbstractSocketClient
- ERROR_INVALID_TRANSACTION - Static variable in exception com.clickhouse.client.ClickHouseTransactionException
- ERROR_NETWORK - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_POCO - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_READ_TIMEOUT - Static variable in class com.clickhouse.client.AbstractSocketClient
- ERROR_SESSION_IS_LOCKED - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_SESSION_NOT_FOUND - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_SUSPICIOUS_TYPE_FOR_LOW_CARDINALITY - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_TIMEOUT - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_UNKNOWN - Static variable in exception com.clickhouse.client.ClickHouseException
- ERROR_UNKNOWN_STATUS_OF_TRANSACTION - Static variable in exception com.clickhouse.client.ClickHouseTransactionException
- ERROR_WRITE_TIMEOUT - Static variable in class com.clickhouse.client.AbstractSocketClient
- execute() - Method in class com.clickhouse.client.ClickHouseRequest
-
Executes the request.
- execute(ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
- execute(ClickHouseRequest<?>) - Method in interface com.clickhouse.client.ClickHouseClient
-
Creates an immutable copy of the request if it's not sealed, and sends it to a node hold by the request(e.g.
- executeAndWait() - Method in class com.clickhouse.client.ClickHouseRequest
-
Synchronous version of
ClickHouseRequest.execute()
. - executeAndWait(ClickHouseRequest<?>) - Method in interface com.clickhouse.client.ClickHouseClient
-
Synchronous version of
ClickHouseClient.execute(ClickHouseRequest)
. - executeWithinTransaction() - Method in class com.clickhouse.client.ClickHouseRequest
-
Executes the request within an implicit transaction.
- executeWithinTransaction(boolean) - Method in class com.clickhouse.client.ClickHouseRequest
-
Deprecated.will be removed in the future, once the minimum supported version of ClickHouse is 22.7 or above
- external(ClickHouseExternalTable, ClickHouseExternalTable...) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets one or more external tables.
- external(Collection<ClickHouseExternalTable>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets external tables.
- externalTables - Variable in class com.clickhouse.client.ClickHouseRequest
F
- FAILED - Static variable in class com.clickhouse.client.ClickHouseTransaction
- failedResponse(Throwable) - Method in class com.clickhouse.client.AbstractClient
- FAILOVER - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum number of times failover can happen for a request.
- FAULTY - Enum constant in enum com.clickhouse.client.ClickHouseNode.Status
-
Faulty status.
- faultyNodes - Variable in class com.clickhouse.client.ClickHouseNodes
-
List of faulty nodes.
- FIRST_ALIVE - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Similar as the default policy, which always picks the first healthy node.
- firstRecord() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets the first record only.
- firstRecord(Class<T>) - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets the first record as mapped object.
- forCancellation(Exception, ClickHouseNode) - Static method in exception com.clickhouse.client.ClickHouseException
-
Creates an exception for cancellation.
- format(ClickHouseFormat) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets format to be used for communication between server and client.
- format(ClickHouseFormat) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
- FORMAT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Default format.
- FORMAT - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default format.
- freezeOptions() - Method in class com.clickhouse.client.ClickHouseRequest
-
Freezes options to discard future changes.
- freezeSettings() - Method in class com.clickhouse.client.ClickHouseRequest
-
Freezes settings to discard future changes.
- fromAccessToken(String) - Static method in class com.clickhouse.client.ClickHouseCredentials
-
Create credentials from access token.
- fromKey(String) - Static method in enum com.clickhouse.client.config.ClickHouseClientOption
-
Gets client option by key.
- fromUriScheme(String) - Static method in enum com.clickhouse.client.ClickHouseProtocol
-
Gets most suitable protocol according to given URI scheme.
- fromUserAndPassword(String, String) - Static method in class com.clickhouse.client.ClickHouseCredentials
-
Create credentials from user name and password.
G
- get() - Method in class com.clickhouse.client.ClickHouseNodes
-
Gets next node available.
- get(ClickHouseNodes) - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets next node available in the list.
- get(ClickHouseNodes, ClickHouseNodeSelector) - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets next node available in the list according to the given node selector.
- getAccessToken() - Method in class com.clickhouse.client.ClickHouseCredentials
-
Get access token.
- getAddress() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets socket address to connect to this node.
- getAllocatedBytes() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- getAllOptions() - Method in class com.clickhouse.client.ClickHouseConfig
- getAsyncExecArguments(ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
-
Gets arguments required for async execution.
- getAsyncRequestOutputStream(ClickHouseConfig, OutputStream, Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Gets piped output stream for writing data into request asynchronously.
- getAsyncResponseInputStream(ClickHouseConfig, InputStream, Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Gets piped input stream for reading data from response asynchronously.
- getBaseUri() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets base URI which is composed of protocol, host and port.
- getBlocks() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- getBoolOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
-
Shortcut of
getOption(option, Boolean.class)
. - getBufferQueueVariation() - Method in class com.clickhouse.client.ClickHouseConfig
- getBufferSize() - Method in class com.clickhouse.client.ClickHouseConfig
- getChangeListener() - Method in class com.clickhouse.client.ClickHouseRequest
- getClient() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets client associated with the request.
- getClientHost() - Method in class com.clickhouse.client.ClickHouseConfig
-
Same as
ClickHouseClientOption.CLIENT_HOST
. - getClientJvmInfo() - Method in class com.clickhouse.client.ClickHouseConfig
- getClientName() - Method in class com.clickhouse.client.ClickHouseConfig
- getClientOsInfo() - Method in class com.clickhouse.client.ClickHouseConfig
- getClientUser() - Method in class com.clickhouse.client.ClickHouseConfig
-
Same as
ClickHouseClientOption.CLIENT_USER
. - getCluster() - Method in class com.clickhouse.client.ClickHouseCluster
- getCluster() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets cluster name of the node.
- getColumnRenameMethod() - Method in class com.clickhouse.client.ClickHouseConfig
- getColumns() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets list of columns.
- getColumns() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- getColumns() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- getConfig() - Method in class com.clickhouse.client.AbstractClient
- getConfig() - Method in interface com.clickhouse.client.ClickHouseClient
-
Gets the immutable configuration associated with this client.
- getConfig() - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Gets client configuration.
- getConfig() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets configuration.
- getConfig() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets request configuration.
- getConnection(ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
-
Gets a connection according to the given request.
- getConnectionTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getCredentials() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getCredentials() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets credentials for accessing this node.
- getCredentials(ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseNode
-
Gets credentials for accessing this node.
- getCustomSettings() - Method in class com.clickhouse.client.ClickHouseConfig
- getCustomSocketFactory() - Method in class com.clickhouse.client.ClickHouseConfig
- getCustomSocketFactory(String, ClickHouseSocketFactory, Class<?>) - Static method in class com.clickhouse.client.AbstractSocketClient
- getCustomSocketFactoryOptions() - Method in class com.clickhouse.client.ClickHouseConfig
- getDatabase() - Method in class com.clickhouse.client.ClickHouseConfig
- getDatabase() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets database of the node.
- getDatabase(ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseNode
-
Gets database of the node.
- getDefaultCredentials() - Method in class com.clickhouse.client.ClickHouseConfig
- getDefaultPort() - Method in enum com.clickhouse.client.ClickHouseProtocol
-
Get default port used by the protocol.
- getDefaultSecurePort() - Method in enum com.clickhouse.client.ClickHouseProtocol
-
Get default secure port used by the protocol.
- getDefaultValue() - Method in enum com.clickhouse.client.config.ClickHouseClientOption
- getDefaultValue() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- getDescription() - Method in enum com.clickhouse.client.config.ClickHouseClientOption
- getDescription() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- getErrorCode() - Method in exception com.clickhouse.client.ClickHouseException
-
Gets error code.
- getExecutor() - Method in class com.clickhouse.client.AbstractClient
-
Gets executor service for this client.
- getExecutorService() - Static method in interface com.clickhouse.client.ClickHouseClient
- getExternalTables() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets immutable list of external tables.
- getFailover() - Method in class com.clickhouse.client.ClickHouseConfig
- getFaultyNodes() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets a copy of faulty nodes.
- getFaultyNodes() - Method in class com.clickhouse.client.ClickHouseNodes
- getFaultyNodes(ClickHouseNodeSelector, int) - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets a copy of filtered faulty nodes.
- getFaultyNodes(ClickHouseNodeSelector, int) - Method in class com.clickhouse.client.ClickHouseNodes
- getFormat() - Method in class com.clickhouse.client.ClickHouseConfig
- getFormat() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets data format used for communication between server and client.
- getFormat() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- getHost() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getHost() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets host of the node.
- getHostId() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- getId() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Gets current transaction ID.
- getInputStream() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets input stream.
- getInputStream() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets input stream of the response.
- getInputStream() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- getInputStream() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- getInstance() - Static method in class com.clickhouse.client.ClickHouseDnsResolver
- getInstance() - Static method in class com.clickhouse.client.ClickHouseRequestManager
-
Gets instance of request manager.
- getIntOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
-
Shortcut of
getOption(option, Integer.class)
. - getJavaSslContext(ClickHouseConfig) - Method in class com.clickhouse.client.config.ClickHouseDefaultSslContextProvider
- getKey() - Method in enum com.clickhouse.client.config.ClickHouseClientOption
- getKey() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- getKeyStore(String, String) - Method in class com.clickhouse.client.config.ClickHouseDefaultSslContextProvider
- getKeyStoreType() - Method in class com.clickhouse.client.ClickHouseConfig
- getLocalTransactionCounter() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- getLongOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
-
Shortcut of
getOption(option, Long.class)
. - getManager() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets manager for the request, which defaults to
ClickHouseRequestManager.getInstance()
. - getMaxBufferSize() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxExecutionTime() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxMapperCache() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxQueuedBuffers() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxQueuedRequests() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxResultRows() - Method in class com.clickhouse.client.ClickHouseConfig
- getMaxThreadsPerClient() - Method in class com.clickhouse.client.ClickHouseConfig
- getMetricRegistry() - Method in class com.clickhouse.client.ClickHouseConfig
- getNodeCheckInterval() - Method in class com.clickhouse.client.ClickHouseConfig
- getNodes() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets a copy of nodes, which in most cases are in healthy status.
- getNodes() - Method in class com.clickhouse.client.ClickHouseNodes
- getNodes(ClickHouseNodeSelector, int) - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets a copy of filtered nodes.
- getNodes(ClickHouseNodeSelector, int) - Method in class com.clickhouse.client.ClickHouseNodes
- getNodeSelector() - Method in class com.clickhouse.client.ClickHouseConfig
- getNodeSelector() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets node selector for filtering out nodes.
- getNodeSelector() - Method in class com.clickhouse.client.ClickHouseNodes
- getOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
- getOption(ClickHouseOption, ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets option value.
- getOption(ClickHouseOption, ClickHouseDefaults) - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets option value.
- getOption(ClickHouseOption, Class<T>) - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets typed option value.
- getOptionClass() - Method in interface com.clickhouse.client.ClickHouseClient
-
Gets class defining client-specific options.
- getOptions() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getOptions() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets all options of the node.
- getOriginalQuery() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Gets original query.
- getOrStartTransaction(ClickHouseRequest<?>) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Gets or starts a new transaction.
- getOrStartTransaction(ClickHouseRequest<?>, int) - Method in class com.clickhouse.client.ClickHouseRequestManager
-
Gets or starts a new transaction.
- getOutputStream() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets output stream.
- getParameters() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Gets named parameters.
- getParameterTemplates() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Gets parameter templates for converting value to SQL expression.
- getParts() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Gets immutable list of query parts.
- getPassword() - Method in class com.clickhouse.client.ClickHouseCredentials
-
Get password.
- getPolicy() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Gets load balancing policy.
- getPolicy() - Method in class com.clickhouse.client.ClickHouseNodes
- getPort() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getPort() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets port of the node.
- getPreferredProtocols() - Method in class com.clickhouse.client.ClickHouseConfig
- getPreferredProtocols() - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Gets preferred protocols.
- getPreferredTags() - Method in class com.clickhouse.client.ClickHouseConfig
- getPreferredTags() - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Gets preferred tags.
- getPrefix() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- getPreparedQuery() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets prepared query, which is a loosely parsed query with the origianl query and list of parameters.
- getProductName() - Method in class com.clickhouse.client.ClickHouseConfig
- getProductRevision() - Method in class com.clickhouse.client.ClickHouseConfig
- getProductVersion() - Method in class com.clickhouse.client.ClickHouseConfig
- getProgress() - Method in class com.clickhouse.client.ClickHouseResponseSummary
-
Gets current progress of the query.
- getProtocol() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getProtocol() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets protocol used by the node.
- getProtocol() - Method in exception com.clickhouse.client.UnsupportedProtocolException
- getProvider() - Static method in interface com.clickhouse.client.ClickHouseSslContextProvider
-
Get non-null SSL context provider.
- getProxyHost() - Method in class com.clickhouse.client.ClickHouseConfig
- getProxyPort() - Method in class com.clickhouse.client.ClickHouseConfig
- getProxyType() - Method in class com.clickhouse.client.ClickHouseConfig
-
Deprecated.will be dropped in 0.5, please use
ClickHouseConfig.getProxyType()
instead - getQuery() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets query, either set by
query()
ortable()
. - getQuery() - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
- getQueryForAllLocalNodes() - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets a SQL query for finding all local nodes regardless which cluster it belongs to.
- getQueryForClusterLocalNodes() - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets a parameterized SQL query for finding all local nodes of a specific cluster.
- getQueryForNonLocalNodes() - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets a parameterized SQL query for finding all non-local nodes in one or many clusters.
- getQueryId() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets query id.
- getQueryParts() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Gets query parts.
- getReadBufferingMode() - Method in class com.clickhouse.client.ClickHouseConfig
- getReadBufferSize() - Method in class com.clickhouse.client.ClickHouseConfig
- getReadBytes() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getReadBytes() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- getReadRows() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getReadRows() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- getReadTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getRequestBuffering() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets request buffering mode.
- getRequestChunkSize() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets request chunk size.
- getRequestCompressAlgorithm() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets input compress algorithm.
- getRequestCompressLevel() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets input compress level.
- getRequestOutputStream(ClickHouseConfig, OutputStream, Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Gets wrapped output stream for writing data into request.
- getResponseBuffering() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets response buffering mode.
- getResponseCompressAlgorithm() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets server response compress algorithm.
- getResponseCompressLevel() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets input compress level.
- getResponseInputStream(ClickHouseConfig, InputStream, Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Gets wrapped input stream for reading data from response.
- getRetry() - Method in class com.clickhouse.client.ClickHouseConfig
- getRows() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- getRowsBeforeLimit() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- getScheduler() - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets scheduled executor service for auto discovery and health check.
- getServer() - Method in class com.clickhouse.client.AbstractClient
-
Gets current server.
- getServer() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets the server currently connected to.
- getServer() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Gets server of the transaction.
- getServerListener() - Method in class com.clickhouse.client.ClickHouseRequest
- getServerTimeZone() - Method in class com.clickhouse.client.ClickHouseConfig
- getServerVersion() - Method in class com.clickhouse.client.ClickHouseConfig
- getSessionId() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets session id.
- getSessionId() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Gets session id of the transaction.
- getSessionTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getSetting(String, Class<T>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets typed setting value.
- getSetting(String, T) - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets typed setting value.
- getSettings() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets immutable settings.
- getSnapshotVersion() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- getSocketChannel() - Method in class com.clickhouse.client.AbstractSocketClient
- getSocketTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getSslCert() - Method in class com.clickhouse.client.ClickHouseConfig
- getSslContext(Class<? extends T>, ClickHouseConfig) - Method in interface com.clickhouse.client.ClickHouseSslContextProvider
-
Get SSL context.
- getSslContext(Class<? extends T>, ClickHouseConfig) - Method in class com.clickhouse.client.config.ClickHouseDefaultSslContextProvider
- getSslKey() - Method in class com.clickhouse.client.ClickHouseConfig
- getSslMode() - Method in class com.clickhouse.client.ClickHouseConfig
- getSslRootCert() - Method in class com.clickhouse.client.ClickHouseConfig
- getState() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Gets transaction state, one of
ClickHouseTransaction.NEW
,ClickHouseTransaction.ACTIVE
,ClickHouseTransaction.COMMITTED
,ClickHouseTransaction.ROLLED_BACK
, orClickHouseTransaction.FAILED
. - getStatements() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets list of SQL statements.
- getStatements(boolean) - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets list of SQL statements.
- getStatistics() - Method in class com.clickhouse.client.ClickHouseResponseSummary
-
Gets statistics of the query.
- getStrOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
-
Shortcut of
getOption(option, String.class)
. - getSummary() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets summary of this response.
- getSummary() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- getSummary() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- getSupportedProtocols() - Method in class com.clickhouse.client.AbstractClient
-
Gets list of supported protocols.
- getSystemConfig(String, String) - Static method in enum com.clickhouse.client.config.ClickHouseClientOption
-
Gets system property and fall back to the given value as needed.
- getTags() - Method in class com.clickhouse.client.ClickHouseNode.Builder
- getTags() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets all tags of the node.
- getTemplate() - Method in class com.clickhouse.client.ClickHouseNodes
- getTimeout() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Gets transaction timeout in seconds.
- getTimeZone() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets time zone of the node.
- getTimeZone(ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseNode
-
Gets time zone of the node.
- getTimeZoneForDate() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets time zone for date values.
- getTotalRowsToRead() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getTotalRowsToRead() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- getTransaction() - Method in class com.clickhouse.client.ClickHouseRequest
- getTransaction() - Method in exception com.clickhouse.client.ClickHouseTransactionException
- getTransactionTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getTrustStore() - Method in class com.clickhouse.client.ClickHouseConfig
- getTrustStorePassword() - Method in class com.clickhouse.client.ClickHouseConfig
- getUpdateCount() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getUriSchemes() - Method in enum com.clickhouse.client.ClickHouseProtocol
-
Gets supported URI schemes.
- getUserName() - Method in class com.clickhouse.client.ClickHouseCredentials
-
Get user name.
- getUseTimeZone() - Method in class com.clickhouse.client.ClickHouseConfig
-
Gets preferred time zone.
- getValueType() - Method in enum com.clickhouse.client.config.ClickHouseClientOption
- getValueType() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- getVersion() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets version of the node.
- getVersion(ClickHouseConfig) - Method in class com.clickhouse.client.ClickHouseNode
-
Gets version of the node.
- getWeight() - Method in class com.clickhouse.client.ClickHouseNode
-
Gets weight of the node.
- getWriteBufferingMode() - Method in class com.clickhouse.client.ClickHouseConfig
- getWriteBufferSize() - Method in class com.clickhouse.client.ClickHouseConfig
- getWriter() - Method in class com.clickhouse.client.ClickHouseRequest
-
Gets custom writer for writing raw request.
- getWriteTimeout() - Method in class com.clickhouse.client.ClickHouseConfig
- getWrittenBytes() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getWrittenBytes() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- getWrittenRows() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- getWrittenRows() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- groupSize - Variable in class com.clickhouse.client.ClickHouseNodes
-
Maximum number of nodes can be used for operation at a time.
- GRPC - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
GRPC interface.
H
- hasAppliedLimit() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- hashCode() - Method in class com.clickhouse.client.ClickHouseCluster
- hashCode() - Method in class com.clickhouse.client.ClickHouseConfig
- hashCode() - Method in class com.clickhouse.client.ClickHouseCredentials
- hashCode() - Method in class com.clickhouse.client.ClickHouseNode
- hashCode() - Method in class com.clickhouse.client.ClickHouseNodes
- hashCode() - Method in class com.clickhouse.client.ClickHouseNodeSelector
- hashCode() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
- hashCode() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- hashCode() - Method in class com.clickhouse.client.ClickHouseTransaction
- hashCode() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- hasInputStream() - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if the request contains any input stream or custom writer.
- hasOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseConfig
-
Test whether a given option is configured or not.
- hasOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if a option has been defined or not.
- hasOption(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if a option has been defined or not.
- hasOutputStream() - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if the response should be redirected to an output stream, which was defined by one of
output(*)
methods. - hasParameter() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Checks if the query has at least one parameter or not.
- hasPreferredDatabase() - Method in class com.clickhouse.client.ClickHouseNode
-
Checks if preferred database was specified or not.
- hasServerInfo() - Method in class com.clickhouse.client.ClickHouseConfig
-
Checks whether we got all server information(e.g.
- hasSetting(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if a setting has been defined or not.
- HEALTH_CHECK_INTERVAL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Health check interval in milliseconds.
- HEALTH_CHECK_METHOD - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Health check method.
- healthCheckFuture - Variable in class com.clickhouse.client.ClickHouseNodes
-
Reference holding future of scheduled health check.
- HEALTHY - Enum constant in enum com.clickhouse.client.ClickHouseNode.Status
-
Healthy status.
- host - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- host(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets host name.
- HOST - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default server host.
- HTTP - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
HTTP/HTTPS interface.
- HTTP - Enum constant in enum com.clickhouse.client.config.ClickHouseProxyType
I
- IGNORE - Enum constant in enum com.clickhouse.client.config.ClickHouseProxyType
- index - Variable in class com.clickhouse.client.ClickHouseNodes
-
Index for retrieving next node.
- init(ClickHouseConfig) - Method in class com.clickhouse.client.AbstractClient
- init(ClickHouseConfig) - Method in interface com.clickhouse.client.ClickHouseClient
-
Initializes the client using immutable configuration extracted from the builder using
ClickHouseClientBuilder.getConfig()
. - input - Variable in class com.clickhouse.client.ClickHouseRequest
- isActive() - Method in class com.clickhouse.client.AbstractSocketClient
- isActive() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks whether the transation's state is
ClickHouseTransaction.ACTIVE
. - isAsync() - Method in class com.clickhouse.client.ClickHouseConfig
- isAutoDiscovery() - Method in class com.clickhouse.client.ClickHouseConfig
- isClosed() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Checks whether the response has been closed or not.
- isClosed() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- isClosed() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- isCommitted() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks whether the transation's state is
ClickHouseTransaction.COMMITTED
. - isConnectTimedOut(Throwable) - Static method in exception com.clickhouse.client.ClickHouseException
-
Checks if the given exception represents connection timeout error.
- isEmpty() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- isEmpty() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Progress
- isEmpty() - Method in class com.clickhouse.client.ClickHouseResponseSummary.Statistics
- isFailed() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks whether the transation's state is
ClickHouseTransaction.FAILED
. - isImplicit() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks if the transaction is implicit or not.
- isManaged() - Method in class com.clickhouse.client.ClickHouseNode
-
Checks whether the node is managed by a
ClickHouseCluster
roClickHouseNodes
. - isNew() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks whether the transation's state is
ClickHouseTransaction.NEW
. - isRepeatOnSessionLock() - Method in class com.clickhouse.client.ClickHouseConfig
- isRequestCompressed() - Method in class com.clickhouse.client.ClickHouseConfig
-
Checks if client's output, aka.
- isResponseCompressed() - Method in class com.clickhouse.client.ClickHouseConfig
-
Checks if server response is compressed or not.
- isReuseValueWrapper() - Method in class com.clickhouse.client.ClickHouseConfig
- isRolledBack() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Checks whether the transation's state is
ClickHouseTransaction.ROLLED_BACK
. - isSameEndpoint(ClickHouseNode) - Method in class com.clickhouse.client.ClickHouseNode
-
Checks if the given node has same base URI as current one.
- isSealed() - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if the request is sealed(immutable).
- isSensitive() - Method in enum com.clickhouse.client.config.ClickHouseClientOption
- isSensitive() - Method in enum com.clickhouse.client.config.ClickHouseDefaults
- isSessionCheck() - Method in class com.clickhouse.client.ClickHouseConfig
- isShutdown() - Method in class com.clickhouse.client.AbstractSocketClient
- isSingleNode() - Method in class com.clickhouse.client.ClickHouseNodes
-
Checks whether it's single node or not.
- isSsl() - Method in class com.clickhouse.client.ClickHouseConfig
- isStandalone() - Method in class com.clickhouse.client.ClickHouseNode
-
Checks whether the node is not managed by any
ClickHouseCluster
roClickHouseNodes
. - issue(String) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Issues transaction related query.
- issue(String, boolean, Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Issues transaction related query.
- isTransactional() - Method in class com.clickhouse.client.ClickHouseRequest
-
Checks if the request is bounded with a transaction.
- isUseBinaryString() - Method in class com.clickhouse.client.ClickHouseConfig
- isUseBlockingQueue() - Method in class com.clickhouse.client.ClickHouseConfig
- isUseCompilation() - Method in class com.clickhouse.client.ClickHouseConfig
- isUseObjectsInArray() - Method in class com.clickhouse.client.ClickHouseConfig
- isUseServerTimeZone() - Method in class com.clickhouse.client.ClickHouseConfig
- isUseServerTimeZoneForDates() - Method in class com.clickhouse.client.ClickHouseConfig
- isWidenUnsignedTypes() - Method in class com.clickhouse.client.ClickHouseConfig
K
- KEY_STORE_PASSWORD - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Trust Store password.
- KEY_STORE_TYPE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Key Store type.
L
- lastUpdateTime - Variable in class com.clickhouse.client.ClickHouseNode
-
Last update time in milliseconds.
- load(ClickHouseNode, String, ClickHousePassThruStream) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Loads data from the given pass-thru stream into a table.
- load(ClickHouseNode, String, ClickHouseWriter, ClickHouseCompression, ClickHouseFormat) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Loads data from a customer writer into table using specified format and compression algorithm.
- load(ClickHouseNode, String, InputStream, ClickHouseCompression, ClickHouseFormat) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Loads data from input stream into a table using specified format and compression algorithm.
- load(ClickHouseNode, String, String, ClickHouseCompression, ClickHouseFormat) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Loads data from a file into table using specified format and compression algorithm.
- LOAD_BALANCING_POLICY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Load balancing policy.
- LOAD_BALANCING_TAGS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Load balancing tags for filtering out nodes.
- LOCAL - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
Local/File interface.
- localAddress() - Method in class com.clickhouse.client.AbstractSocketClient
- lock - Variable in class com.clickhouse.client.AbstractClient
- lock - Variable in class com.clickhouse.client.ClickHouseNodes
-
Lock for read and write
nodes
andfaultyNodes
. - LOG_LEADING_COMMENT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to log leading comment(as log_comment in system.query_log) of the query.
M
- MANAGED - Enum constant in enum com.clickhouse.client.ClickHouseNode.Status
-
Managed status.
- manager - Variable in class com.clickhouse.client.ClickHouseNode
- manager(ClickHouseRequestManager) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets request manager which is responsible for generating query ID and session ID, as well as transaction creation.
- managerRef - Variable in class com.clickhouse.client.ClickHouseRequest
- match(ClickHouseClient) - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Test if the given client supports any of
ClickHouseNodeSelector.getPreferredProtocols()
. - match(ClickHouseNode) - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Checks if the given node matches any of preferred protocols and tags.
- matchAllPreferredTags(Collection<String>) - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Checks if the preferred tags contain all of given tags.
- matchAnyOfPreferredProtocols(ClickHouseProtocol) - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Checks if the given protocol matches any of the preferred protocols.
- matchAnyOfPreferredTags(Collection<String>) - Method in class com.clickhouse.client.ClickHouseNodeSelector
-
Checks if the preferred tags contain any of given tags.
- MAX_BUFFER_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum buffer size in byte can be used for streaming.
- MAX_EXECUTION_TIME - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum query execution time in seconds.
- MAX_MAPPER_CACHE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum number of mappers can be cached.
- MAX_QUEUED_BUFFERS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum queued in-memory buffers.
- MAX_QUEUED_REQUESTS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maxium queued requests.
- MAX_REQUESTS - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Max requests.
- MAX_RESULT_ROWS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum rows allowed in the result.
- MAX_SCHEDULER_THREADS - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Maximum number of threads that the scheduler(shared by all client instances) can use to run the adhoc/scheduled tasks like discovery and health check.
- MAX_THREADS - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Max threads.
- MAX_THREADS_PER_CLIENT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum size of thread pool for each client.
- mergeCredentials(List<ClickHouseConfig>) - Static method in class com.clickhouse.client.ClickHouseConfig
- mergeMetricRegistry(List<ClickHouseConfig>) - Static method in class com.clickhouse.client.ClickHouseConfig
- mergeNodeSelector(List<ClickHouseConfig>) - Static method in class com.clickhouse.client.ClickHouseConfig
- mergeOptions(List<ClickHouseConfig>) - Static method in class com.clickhouse.client.ClickHouseConfig
- metricRegistry - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- metricRegistry(Object) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets metric registry.
- Mutation(ClickHouseRequest<?>, boolean) - Constructor for class com.clickhouse.client.ClickHouseRequest.Mutation
- MYSQL - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
MySQL interface.
N
- namedParameters - Variable in class com.clickhouse.client.ClickHouseRequest
- NEW - Static variable in class com.clickhouse.client.ClickHouseTransaction
- newConnection(T, ClickHouseNode, ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
-
Creates a new connection and optionally close existing connection.
- newInstance() - Static method in class com.clickhouse.client.ClickHouseDnsResolver
- newInstance(ClickHouseCredentials, ClickHouseProtocol...) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Creates a new instance with default credentials compatible with any of the given protocols.
- newInstance(ClickHouseProtocol...) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Creates a new instance compatible with any of the given protocols.
- NODE_CHECK_INTERVAL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Node check interval in milliseconds.
- NODE_DISCOVERY_INTERVAL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Node discovery interval in milliseconds.
- NODE_DISCOVERY_LIMIT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum number of nodes can be discovered at a time.
- NODE_GROUP_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum number of nodes can be used for operation at a time.
- nodes - Variable in class com.clickhouse.client.ClickHouseNodes
-
List of healthy nodes.
- nodeSelector - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- nodeSelector(ClickHouseNodeSelector) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets node selector.
- NONE - Enum constant in enum com.clickhouse.client.config.ClickHouseSslMode
O
- of(ClickHouseConfig, ClickHouseInputStream) - Static method in class com.clickhouse.client.ClickHouseStreamResponse
- of(ClickHouseConfig, ClickHouseInputStream, List<ClickHouseColumn>) - Static method in class com.clickhouse.client.ClickHouseStreamResponse
- of(ClickHouseConfig, ClickHouseInputStream, Map<String, Serializable>) - Static method in class com.clickhouse.client.ClickHouseStreamResponse
- of(ClickHouseConfig, ClickHouseInputStream, Map<String, Serializable>, List<ClickHouseColumn>) - Static method in class com.clickhouse.client.ClickHouseStreamResponse
- of(ClickHouseConfig, ClickHouseInputStream, Map<String, Serializable>, List<ClickHouseColumn>, ClickHouseResponseSummary) - Static method in class com.clickhouse.client.ClickHouseStreamResponse
- of(ClickHouseConfig, String) - Static method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Creates an instance by parsing the given query.
- of(ClickHouseConfig, List<ClickHouseColumn>, Object[][]) - Static method in class com.clickhouse.client.ClickHouseSimpleResponse
-
Creates a response object using columns definition and raw values.
- of(ClickHouseConfig, List<ClickHouseColumn>, Object[][], ClickHouseResponseSummary) - Static method in class com.clickhouse.client.ClickHouseSimpleResponse
-
Creates a response object using columns definition and raw values.
- of(ClickHouseNode, ClickHouseNode...) - Static method in class com.clickhouse.client.ClickHouseCluster
-
Creates cluster object from list of nodes.
- of(ClickHouseProtocol, ClickHouseProtocol...) - Static method in class com.clickhouse.client.ClickHouseNodeSelector
-
Creates a node selector by specifying preferred protocols.
- of(ClickHouseResponse) - Static method in class com.clickhouse.client.ClickHouseSimpleResponse
-
Creates a response object by copying columns and values from the given one.
- of(ClickHouseResponse, ClickHouseRecordTransformer) - Static method in class com.clickhouse.client.ClickHouseSimpleResponse
-
Creates a response object by copying columns and values from the given one.
- of(String) - Static method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Gets or creates singleton load balancing policy.
- of(String) - Static method in class com.clickhouse.client.ClickHouseNode
-
Creates a node object using given URI.
- of(String) - Static method in class com.clickhouse.client.ClickHouseNodes
-
Gets or creates list of managed
ClickHouseNode
for load balancing and fail-over. - of(String, ClickHouseNode) - Static method in exception com.clickhouse.client.ClickHouseException
-
Creates an exception to encapsulate the given error message.
- of(String, ClickHouseNode) - Static method in class com.clickhouse.client.ClickHouseNode
-
Creates a node object using given URI and template.
- of(String, ClickHouseNode, ClickHouseNode...) - Static method in class com.clickhouse.client.ClickHouseCluster
-
Creates cluster object from list of nodes.
- of(String, ClickHouseProtocol, int, String, String...) - Static method in class com.clickhouse.client.ClickHouseNode
-
Creates a node object in one go.
- of(String, String...) - Static method in class com.clickhouse.client.ClickHouseNodeSelector
-
Creates a node selector by specifying preferred tags.
- of(String, String, Map<?, ?>) - Static method in class com.clickhouse.client.ClickHouseNodes
-
Gets or creates list of managed
ClickHouseNode
for load balancing and fail-over. - of(String, Collection<ClickHouseNode>) - Static method in class com.clickhouse.client.ClickHouseCluster
- of(String, Map<?, ?>) - Static method in class com.clickhouse.client.ClickHouseNode
-
Creates a node object using given URI.
- of(String, Map<?, ?>) - Static method in class com.clickhouse.client.ClickHouseNodes
-
Gets or creates list of managed
ClickHouseNode
for load balancing and fail-over. - of(Throwable, ClickHouseNode) - Static method in exception com.clickhouse.client.ClickHouseException
-
Creates an exception to encapsulate cause of the given exception.
- of(URI, ClickHouseNode) - Static method in class com.clickhouse.client.ClickHouseNode
-
Creates a node object using given URI.
- of(Collection<ClickHouseProtocol>, Collection<String>) - Static method in class com.clickhouse.client.ClickHouseNodeSelector
-
Creates a node selector by specifying preferred protocols and tags.
- of(List<?>) - Static method in class com.clickhouse.client.ClickHouseTransaction.XID
-
Creates transaction ID from the given tuple.
- onConnect(ClickHouseConfig, SocketChannel) - Method in class com.clickhouse.client.AbstractSocketClient
- onRead(ClickHouseConfig, SocketChannel, ClickHouseOutputStream) - Method in class com.clickhouse.client.AbstractSocketClient
-
Reads byte from socket input buffer.
- onWrite(ClickHouseConfig, SocketChannel, ClickHouseInputStream, long) - Method in class com.clickhouse.client.AbstractSocketClient
- option(ClickHouseOption, Serializable) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Adds an option, which is usually an Enum type that implements
ClickHouseOption
. - option(ClickHouseOption, Serializable) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets an option.
- options - Variable in class com.clickhouse.client.ClickHouseClientBuilder
- options - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- options - Variable in class com.clickhouse.client.ClickHouseRequest
- options(Map<ClickHouseOption, Serializable>) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Sets options.
- options(Map<ClickHouseOption, Serializable>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets all options.
- options(Map<String, String>) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets all options for this node.
- options(Properties) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets all options.
- originalQuery - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery
- output - Variable in class com.clickhouse.client.ClickHouseRequest
- output(ClickHouseDeferredValue<ClickHouseOutputStream>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets output stream, to which response will be redirected.
- output(ClickHouseOutputStream) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets output stream, to which response will be redirected.
- output(ClickHousePassThruStream) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets pass-thru stream, to which response will be redirected.
- output(OutputStream) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets output stream, to which response will be redirected.
- output(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets output file, to which response will be redirected.
- output(String, ClickHouseCompression) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets compressed output file, to which response will be redirected.
- output(String, ClickHouseCompression, int) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets compressed output file, to which response will be redirected.
P
- paramIndex - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- paramName - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- params(ClickHouseValue[]) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets parameters wrapped by
ClickHouseValue
. - params(ClickHouseValue, ClickHouseValue...) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets parameters wrapped by
ClickHouseValue
. - params(Object[]) - Method in class com.clickhouse.client.ClickHouseRequest
-
Set raw parameters, which will later be stringified using
ClickHouseValues.convertToSqlExpression(Object)
. - params(Object, Object...) - Method in class com.clickhouse.client.ClickHouseRequest
-
Set raw parameters, which will later be stringified using
ClickHouseValues.convertToSqlExpression(Object)
. - params(String[]) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets stringified parameters which are used to substitude named parameters in SQL query without further transformation and validation.
- params(String, String...) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets stringified parameters which are used to substitude named parameters in SQL query without further transformation and validation.
- params(Collection<String>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets stringified parameters.
- params(Map<String, String>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets named parameters.
- paramType - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- parse() - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Parses the query given in constructor.
- part - Variable in class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
- PASSWORD - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default password.
- ping(ClickHouseNode, int) - Method in class com.clickhouse.client.AbstractClient
- ping(ClickHouseNode, int) - Method in interface com.clickhouse.client.ClickHouseClient
-
Tests if the given server is alive or not.
- PING - Enum constant in enum com.clickhouse.client.config.ClickHouseHealthCheckMethod
-
Ping is the protocol-specific approach for health check, which in general is faster.
- pipe(OutputStream, int) - Method in interface com.clickhouse.client.ClickHouseResponse
-
Pipes the contents of this response into the given output stream.
- policy - Variable in class com.clickhouse.client.ClickHouseNodes
-
Load balancing policy.
- port - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- port(ClickHouseProtocol) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets protocol used by the port.
- port(ClickHouseProtocol, Integer) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets protocol and port number.
- port(Integer) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets port number.
- POSTGRESQL - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
PostgreSQL interface.
- preparedQuery - Variable in class com.clickhouse.client.ClickHouseRequest
- probe() - Method in class com.clickhouse.client.ClickHouseNode
- processor - Variable in class com.clickhouse.client.ClickHouseStreamResponse
- processRequest(ClickHouseConfig, ClickHouseInputStream, ClickHouseOutputStream) - Method in class com.clickhouse.client.AbstractSocketClient
- PRODUCT_NAME - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Product name usered in user agent.
- PRODUCT_REVISION - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Revision(shortened git commit hash) of the product.
- PRODUCT_VERSION - Static variable in enum com.clickhouse.client.config.ClickHouseClientOption
-
Semantic version of the product.
- Progress(long, long, long, long, long) - Constructor for class com.clickhouse.client.ClickHouseResponseSummary.Progress
-
Default constructor.
- protocol - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- PROTOCOL - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default protocol.
- PROXY_HOST - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Set Clickhouse proxy hostname.
- PROXY_PORT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Set ClickHouse proxy port.
- PROXY_TYPE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Type of proxy can be used to access ClickHouse server.
Q
- query(ClickHouseParameterizedQuery) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets parameterized query.
- query(ClickHouseParameterizedQuery, String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets parameterized query and optionally query id.
- query(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets query.
- query(String, String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets query and optionally query id.
- QUERY_GET_ALL_NODES - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
- QUERY_GET_CLUSTER_NODES - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
- QUERY_GET_OTHER_NODES - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
- queryClusterNodes(Collection<ClickHouseNode>, Collection<ClickHouseNode>, Collection<ClickHouseNode>, Collection<ClickHouseNode>, Collection<ClickHouseNode>) - Method in class com.clickhouse.client.ClickHouseNodes
- queryId - Variable in class com.clickhouse.client.ClickHouseRequest
- QueryPart(ClickHouseConfig, String, int, String, String, Map<String, ClickHouseValue>) - Constructor for class com.clickhouse.client.ClickHouseParameterizedQuery.QueryPart
R
- RANDOM - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Policy to pick a healthy node randomly from the list.
- read(ClickHouseNode) - Method in interface com.clickhouse.client.ClickHouseClient
-
Connects to a ClickHouse server to read.
- read(ClickHouseNodes) - Method in interface com.clickhouse.client.ClickHouseClient
-
Connects to a list of managed ClickHouse servers to read.
- read(String) - Method in interface com.clickhouse.client.ClickHouseClient
-
Connects to one or more ClickHouse servers to read.
- read(Function<ClickHouseNodeSelector, ClickHouseNode>, Map<ClickHouseOption, Serializable>) - Method in class com.clickhouse.client.AbstractClient
- read(Function<ClickHouseNodeSelector, ClickHouseNode>, Map<ClickHouseOption, Serializable>) - Method in interface com.clickhouse.client.ClickHouseClient
-
Connects to a ClickHouse server to read.
- READ_BUFFER_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Read buffer size in byte.
- records() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Returns an iterable collection of records which can be walked through in a foreach loop.
- records() - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- records() - Method in class com.clickhouse.client.ClickHouseStreamResponse
- records(Class<T>) - Method in interface com.clickhouse.client.ClickHouseResponse
-
Returns an iterable collection of mapped objects which can be walked through in a foreach loop.
- records(Class<T>) - Method in class com.clickhouse.client.ClickHouseSimpleResponse
- records(Class<T>) - Method in class com.clickhouse.client.ClickHouseStreamResponse
- remoteAddress() - Method in class com.clickhouse.client.AbstractSocketClient
- removeExternal(ClickHouseExternalTable) - Method in class com.clickhouse.client.ClickHouseRequest
-
Removes an external table.
- removeExternal(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Removes an external table by name.
- removeInterestOp(int) - Method in class com.clickhouse.client.AbstractSocketClient
- removeOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Removes an option.
- removeOption(ClickHouseOption) - Method in class com.clickhouse.client.ClickHouseRequest
-
Removes an option.
- removeOption(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Removes an option from this node.
- removeSetting(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Removes a setting.
- removeTag(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Removes a tag from this node.
- RENAME_RESPONSE_COLUMN - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Method to rename response columns.
- REPEAT_ON_SESSION_LOCK - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to repeat execution when session is locked, until timed out(according to
ClickHouseClientOption.SESSION_TIMEOUT
orClickHouseClientOption.CONNECTION_TIMEOUT
). - replica(Integer) - Method in class com.clickhouse.client.ClickHouseNode.Builder
- REQUEST_BUFFERING - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Request buffering mode.
- REQUEST_CHUNK_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum request chunk size in byte.
- reset() - Method in class com.clickhouse.client.ClickHouseRequest
-
Resets the request to start all over.
- resetCache() - Method in class com.clickhouse.client.ClickHouseRequest
- resetConfig() - Method in class com.clickhouse.client.ClickHouseClientBuilder
-
Resets client configuration to null.
- resolve(ClickHouseProtocol, String, int) - Method in class com.clickhouse.client.ClickHouseDnsResolver
- RESPONSE_BUFFERING - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Response buffering mode.
- RETRY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Maximum number of times retry can happen for a request.
- REUSE_VALUE_WRAPPER - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to reuse wrapper of value(e.g.
- rollback() - Method in class com.clickhouse.client.ClickHouseTransaction
-
Rolls back the transaction.
- rollback(Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Rolls back the transaction with optional server settings.
- ROLLED_BACK - Static variable in class com.clickhouse.client.ClickHouseTransaction
- ROUND_ROBIN - Static variable in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Policy to pick healthy node one after another based their order in the list.
- ROUNDING_MODE - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Rounding mode for type conversion.
- run(Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Runs the given task immediately in current thread.
- run(Callable<T>) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Runs the given task immediately in current thread.
S
- schedule(ScheduledFuture<?>, Runnable, long) - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Schedules the
task
to run only whencurrent
run has been completed/cancelled or does not exist. - scheduleDiscovery() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Schedule node discovery task immediately.
- scheduleDiscovery() - Method in class com.clickhouse.client.ClickHouseNodes
- scheduleHealthCheck() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Schedule node discovery task immediately.
- scheduleHealthCheck() - Method in class com.clickhouse.client.ClickHouseNodes
- SCHEME_DELIMITER - Static variable in class com.clickhouse.client.ClickHouseNode
- seal() - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
- seal() - Method in class com.clickhouse.client.ClickHouseRequest
-
Creates a sealed request, which is an immutable copy of the current request.
- seal() - Method in class com.clickhouse.client.ClickHouseResponseSummary
-
Seals the object so that it cannot be updated any more.
- SELECT_ONE - Enum constant in enum com.clickhouse.client.config.ClickHouseHealthCheckMethod
-
Issue query "select 1" for health check, slightly slower compare to ping but works the best with 3party tools.
- selector - Variable in class com.clickhouse.client.ClickHouseNodes
-
Load balancing tags for filtering out nodes.
- send(ClickHouseConfig, ClickHouseInputStream) - Method in class com.clickhouse.client.AbstractSocketClient
- send(ClickHouseConfig, ClickHouseInputStream, ClickHouseOutputStream) - Method in class com.clickhouse.client.AbstractSocketClient
- send(ClickHouseNode, String, ClickHouseValue[], Object[]...) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Sends SQL query along with template objects and raw parameters to specified server.
- send(ClickHouseNode, String, String...) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Sends one or more SQL queries to specified server, and execute them one by one.
- send(ClickHouseNode, String, String[][]) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Sends SQL query along with stringified parameters to specified server.
- send(ClickHouseNode, String, List<ClickHouseColumn>, Object[]...) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Sends SQL query along with raw parameters(e.g.
- send(ClickHouseNode, String, Map<String, String>) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Sends SQL query along with stringified parameters to specified server.
- send(ClickHouseRequest<?>) - Method in class com.clickhouse.client.AbstractClient
-
Sends the request to server in a current thread.
- sendAsync(ClickHouseRequest<?>, Object...) - Method in class com.clickhouse.client.AbstractClient
-
Sends the request to server in a separate thread.
- server - Variable in class com.clickhouse.client.ClickHouseRequest
- SERVER_REVISION - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Server revision.
- SERVER_TIME_ZONE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Server timezone.
- SERVER_TIME_ZONE - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Server time zone, defaults to
UTC
. - SERVER_VERSION - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Server version.
- SERVER_VERSION - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Server version, defaults to
latest
. - serverListener - Variable in class com.clickhouse.client.ClickHouseRequest
- serverRef - Variable in class com.clickhouse.client.ClickHouseRequest
- session(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets current session using custom id.
- session(String, Boolean) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets session.
- session(String, Boolean, Integer) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets current session.
- session(String, Integer) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets current session.
- SESSION_CHECK - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to check if session id is validate.
- SESSION_ID - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Session id.
- SESSION_TIMEOUT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Session timeout in seconds.
- set(String, Serializable) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets a setting.
- set(String, String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets a setting.
- setChangeListener(ClickHouseConfigChangeListener<ClickHouseRequest<?>>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets thread-safe change listener.
- setInterestOp(int) - Method in class com.clickhouse.client.AbstractSocketClient
- setManager(ClickHouseNodeManager) - Method in class com.clickhouse.client.ClickHouseNode
-
Sets manager for this node.
- setServerListener(BiConsumer<ClickHouseNode, ClickHouseNode>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets thread-safe server change listener.
- setSocketOptions(ClickHouseConfig, Socket) - Static method in class com.clickhouse.client.AbstractSocketClient
-
Sets socket options.
- setSocketOptions(ClickHouseConfig, SocketChannel) - Static method in class com.clickhouse.client.AbstractSocketClient
-
Sets socket options.
- SETTING_IMPLICIT_TRANSACTION - Static variable in class com.clickhouse.client.ClickHouseTransaction
- SETTING_THROW_ON_UNSUPPORTED_QUERY_INSIDE_TRANSACTION - Static variable in class com.clickhouse.client.ClickHouseTransaction
- SETTING_WAIT_CHANGES_BECOME_VISIBLE_AFTER_COMMIT_MODE - Static variable in class com.clickhouse.client.ClickHouseTransaction
- settings - Variable in class com.clickhouse.client.ClickHouseRequest
- settings(Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets all server settings.
- shard(Integer, Integer) - Method in class com.clickhouse.client.ClickHouseNode.Builder
- shutdown() - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Shuts down scheduled tasks if any.
- shutdown() - Method in class com.clickhouse.client.ClickHouseNodes
- singleNode - Variable in class com.clickhouse.client.ClickHouseNodes
-
Flag indicating whether it's single node or not.
- snapshot(long) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Sets transaction snapshot with optional server settings.
- snapshot(long, Map<String, Serializable>) - Method in class com.clickhouse.client.ClickHouseTransaction
-
Sets transaction snapshot with optional server settings, only works for
ClickHouseTransaction.ACTIVE
transaction. - SOCKET_IP_TOS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Type-of-service(TOS) or traffic class field in the IP header for a socket.
- SOCKET_KEEPALIVE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to enable keep-alive packets for a socket connection.
- SOCKET_LINGER - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Seconds to wait while data is being transmitted before closing the socket.
- SOCKET_RCVBUF - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Size of the socket receive buffer in bytes.
- SOCKET_REUSEADDR - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether allows for the reuse of local addresses and ports.
- SOCKET_SNDBUF - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Size of the socket send buffer in bytes.
- SOCKET_TCP_NODELAY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
- SOCKET_TIMEOUT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Socket timeout in milliseconds.
- SOCKS - Enum constant in enum com.clickhouse.client.config.ClickHouseProxyType
- sql - Variable in class com.clickhouse.client.ClickHouseRequest
- SRV_RESOLVE - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Whether to resolve DNS SRV name using
SrvResolver
(e.g. - SSL - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to enable SSL for the connection.
- SSL_CERTIFICATE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
SSL certificiate.
- SSL_CERTIFICATE_TYPE - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
SSL certificiate type.
- SSL_KEY - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
SSL key.
- SSL_KEY_ALGORITHM - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
SSL key algorithm.
- SSL_MODE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
SSL mode.
- SSL_PROTOCOL - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
SSL key.
- SSL_ROOT_CERTIFICATE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
SSL root certificiate.
- STANDALONE - Enum constant in enum com.clickhouse.client.ClickHouseNode.Status
-
Standalone status.
- start() - Method in class com.clickhouse.client.AbstractSocketClient
- statements - Variable in class com.clickhouse.client.ClickHouseRequest
- Statistics(long, long, long, boolean, long) - Constructor for class com.clickhouse.client.ClickHouseResponseSummary.Statistics
-
Default constructor.
- stream() - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets stream of records to process.
- stream(Class<T>) - Method in interface com.clickhouse.client.ClickHouseResponse
-
Gets stream of mapped objects to process.
- STRICT - Enum constant in enum com.clickhouse.client.config.ClickHouseSslMode
- submit(Runnable) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Submits task for execution.
- submit(Callable<T>) - Static method in interface com.clickhouse.client.ClickHouseClient
-
Submits task for execution.
- suggest(ClickHouseNodes, ClickHouseNode, Throwable) - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Sugguests a new node as replacement of the given one in order to recover from the failure, which is usually a connection error.
- suggestNode(ClickHouseNode, Throwable) - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Suggests a different node in order to recover from a failure, which is usually a connection error.
- suggestNode(ClickHouseNode, Throwable) - Method in class com.clickhouse.client.ClickHouseNodes
- summary - Variable in class com.clickhouse.client.ClickHouseStreamResponse
- supports(Class<?>) - Method in interface com.clickhouse.client.ClickHouseSocketFactory
-
Tests whether this factory supports creating instances of the given class type.
T
- table(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets target table.
- table(String, String) - Method in class com.clickhouse.client.ClickHouseRequest.Mutation
- table(String, String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets target table and optionally query id.
- tags - Variable in class com.clickhouse.client.ClickHouseNode.Builder
- tags(String, String...) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets all tags for this node.
- tags(Collection<String>) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets all tags for this node.
- TCP - Enum constant in enum com.clickhouse.client.ClickHouseProtocol
-
Native interface.
- template - Variable in class com.clickhouse.client.ClickHouseNodes
-
Template node.
- THREAD_KEEPALIVE_TIMEOUT - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Thread keep alive timeout in milliseconds.
- timeZone(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets time zone of this node.
- timeZone(TimeZone) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets time zone of this node.
- toClientOptions(Map<?, ?>) - Static method in class com.clickhouse.client.ClickHouseConfig
-
Converts given key-value pairs to a mutable map of corresponding
ClickHouseOption
. - toSqlExpression(String, Object) - Method in class com.clickhouse.client.ClickHouseParameterizedQuery
-
Converts given raw value to SQL expression.
- toString() - Method in class com.clickhouse.client.ClickHouseCluster
- toString() - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
- toString() - Method in class com.clickhouse.client.ClickHouseNode
- toString() - Method in class com.clickhouse.client.ClickHouseNodes
- toString() - Method in class com.clickhouse.client.ClickHouseNodeSelector
- toString() - Method in class com.clickhouse.client.ClickHouseResponseSummary
- toString() - Method in class com.clickhouse.client.ClickHouseTransaction
- toString() - Method in class com.clickhouse.client.ClickHouseTransaction.XID
- toUri() - Method in class com.clickhouse.client.ClickHouseNode
-
Converts to URI, without credentials for security reason.
- toUri(String) - Method in class com.clickhouse.client.ClickHouseNode
-
Converts to URI, without credentials for security reason.
- transaction() - Method in class com.clickhouse.client.ClickHouseRequest
-
Creates and starts a transaction.
- transaction(int) - Method in class com.clickhouse.client.ClickHouseRequest
-
Creates and starts a transaction immediately.
- transaction(ClickHouseTransaction) - Method in class com.clickhouse.client.ClickHouseRequest
-
Sets transaction.
- TRANSACTION_TIMEOUT - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Transaction timeout in seconds.
- TRUST_STORE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Trust Store.
- txRef - Variable in class com.clickhouse.client.ClickHouseRequest
- TYPE_NAME - Static variable in class com.clickhouse.client.ClickHouseConfig
U
- unfreezeOptions() - Method in class com.clickhouse.client.ClickHouseRequest
-
Unfreezes options to accept future changes.
- unfreezeSettings() - Method in class com.clickhouse.client.ClickHouseRequest
-
Unfreezes settings to accept future changes.
- UnsupportedProtocolException - Exception in com.clickhouse.client
- UnsupportedProtocolException(ClickHouseProtocol, String) - Constructor for exception com.clickhouse.client.UnsupportedProtocolException
- update() - Method in class com.clickhouse.client.ClickHouseResponseSummary
-
Increases update counter.
- update(ClickHouseNode.Status) - Method in class com.clickhouse.client.ClickHouseNode
-
Updates status of the node.
- update(ClickHouseNode, ClickHouseNode.Status) - Method in interface com.clickhouse.client.ClickHouseNodeManager
-
Updates node status to one of
ClickHouseNode.Status
. - update(ClickHouseNode, ClickHouseNode.Status) - Method in class com.clickhouse.client.ClickHouseNodes
- update(ClickHouseNodes, ClickHouseNode, ClickHouseNode.Status) - Method in class com.clickhouse.client.ClickHouseLoadBalancingPolicy
-
Updates node status to one of
ClickHouseNode.Status
. - update(ClickHouseResponseSummary.Progress) - Method in class com.clickhouse.client.ClickHouseResponseSummary
-
Updates query progress.
- update(ClickHouseResponseSummary.Statistics) - Method in class com.clickhouse.client.ClickHouseResponseSummary
- use(String) - Method in class com.clickhouse.client.ClickHouseRequest
-
Changes current database.
- USE_BINARY_STRING - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to support binary string.
- USE_BLOCKING_QUEUE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to use blocking queue for buffering.
- USE_COMPILATION - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to use compilation(generated byte code) in object mapping and serialization.
- USE_OBJECTS_IN_ARRAYS - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether Object[] should be used instead of primitive arrays.
- USE_SERVER_TIME_ZONE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to use server time zone.
- USE_SERVER_TIME_ZONE_FOR_DATES - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to use time zone from server for Date.
- USE_TIME_ZONE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Custom time zone.
- useAccessToken() - Method in class com.clickhouse.client.ClickHouseCredentials
- USER - Enum constant in enum com.clickhouse.client.config.ClickHouseDefaults
-
Default user.
V
- valueOf(String) - Static method in enum com.clickhouse.client.ClickHouseNode.Status
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.ClickHouseProtocol
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.config.ClickHouseClientOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.config.ClickHouseDefaults
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.config.ClickHouseHealthCheckMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.config.ClickHouseProxyType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.clickhouse.client.config.ClickHouseSslMode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.clickhouse.client.ClickHouseNode.Status
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.ClickHouseProtocol
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.config.ClickHouseClientOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.config.ClickHouseDefaults
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.config.ClickHouseHealthCheckMethod
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.config.ClickHouseProxyType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.clickhouse.client.config.ClickHouseSslMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- version(ClickHouseVersion) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets vesion of this node.
- version(String) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets vesion of this node.
W
- weight(Integer) - Method in class com.clickhouse.client.ClickHouseNode.Builder
-
Sets weight of this node.
- WIDEN_UNSIGNED_TYPES - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Whether to convert unsigned types to the next widest type(e.g.
- write() - Method in class com.clickhouse.client.ClickHouseRequest
-
Creates a new request for mutation.
- write(ClickHouseNode) - Method in interface com.clickhouse.client.ClickHouseClient
-
Writes into a ClickHouse server.
- WRITE_BUFFER_SIZE - Enum constant in enum com.clickhouse.client.config.ClickHouseClientOption
-
Write buffer size in byte.
- writer - Variable in class com.clickhouse.client.ClickHouseRequest
X
- XID(long, long, String) - Constructor for class com.clickhouse.client.ClickHouseTransaction.XID
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form