Package com.clickhouse.client

Provides necessary classes to communicate with ClickHouse server.

Interface Summary

Interface	Description
ClickHouseCache<K,V>	Wrapper interface depicts essential methods required by a client-side cache.
ClickHouseClient	A unified interface defines Java client for ClickHouse.
ClickHouseDeserializer<T extends ClickHouseValue>	Functional interface for deserialization.
ClickHouseRecord	This defines a record returned from ClickHouse server.
ClickHouseResponse	This encapsulates a server reponse.
ClickHouseSerializer<T extends ClickHouseValue>	Functional interface for serializtion.
ClickHouseSslContextProvider	This interface defines how to build Netty SSL context based on given configuration and target server.
ClickHouseValue	Wrapper of a value returned from ClickHouse.
ClickHouseWriter

Class Summary

Class	Description
AbstractClient<T>	Base class for implementing a thread-safe ClickHouse client.
ClickHouseChecker	Utility class for validation.
ClickHouseClientBuilder	Builder class for creating ClickHouseClient.
ClickHouseCluster	List of ClickHouseNode.
ClickHouseCluster.Builder	Builder class for creating ClickHouseCluster.
ClickHouseColumn	This class represents a column defined in database.
ClickHouseConfig	An immutable class holding client-specific options like ClickHouseCredentials and ClickHouseNodeSelector etc.
ClickHouseCredentials	This encapsulates access token, certificate or user name password combination for accessing ClickHouse.
ClickHouseDataProcessor	This defines a data processor for dealing with one or multiple ClickHouseFormat.
ClickHouseDataStreamFactory	Factory class for creating objects to handle data stream.
ClickHouseDnsResolver	Default DNS resolver.
ClickHouseEnum
ClickHouseInputStream	Extended input stream for read optimization.
ClickHouseNode	This class depicts a ClickHouse server, essentially a combination of host, port and protocol, for client to connect.
ClickHouseNode.Builder	Mutable and non-thread safe builder.
ClickHouseNodeSelector	This class maintains two immutable lists: preferred protocols and tags.
ClickHouseParameterizedQuery	A parameterized query is a parsed query with parameters being extracted for substitution.
ClickHouseParameterizedQuery.QueryPart	A part of query.
ClickHouseRequest<SelfT extends ClickHouseRequest<SelfT>>	Request object holding references to ClickHouseClient, ClickHouseNode, format, sql, options and settings etc.
ClickHouseRequest.Mutation	Mutation request.
ClickHouseResponseSummary	Summary of ClickHouse response.
ClickHouseResponseSummary.Progress	Progress of a query.
ClickHouseResponseSummary.Statistics	Statistics of a query.
ClickHouseThreadFactory
ClickHouseUtils
ClickHouseValues	Help class for dealing with values.
ClickHouseVersion	Immutable ClickHouse version, which takes the form Year(Major).Feature(Minor).Maintenance(Patch).Build.

Enum Summary

Enum	Description
ClickHouseAggregateFunction
ClickHouseCluster.LoadBalancingPolicy	Enum of load balancing policy.
ClickHouseCompression	Supported compression algoritms.
ClickHouseDataType	Basic ClickHouse data types.
ClickHouseFormat	All formats supported by ClickHouse.
ClickHouseNode.Status	Node status.
ClickHouseProtocol	This defines protocols can be used to connect to ClickHouse.

Exception Summary

Exception	Description
ClickHouseException	Exception thrown from ClickHouse server.