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.
ClickHouseDataUpdater	This class defines custom reading/writing logic, which can be used in ClickHouseInputStream.readCustom(ClickHouseDataUpdater) and ClickHouseOutputStream.writeCustom(ClickHouseDataUpdater).
ClickHouseDeserializer<T extends ClickHouseValue>	Functional interface for deserialization.
ClickHouseNodeManager	Node manager is responsible for managing list of nodes and their status.
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.
ClickHouseByteBuffer	This class represents a slice of a byte array.
ClickHouseChecker	Utility class for validation.
ClickHouseClientBuilder	Builder class for creating ClickHouseClient.
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 serialization and deserialization of one or multiple ClickHouseFormat.
ClickHouseDataStreamFactory	Factory class for creating objects to handle data stream.
ClickHouseDeferredValue<T>	This class represents a deferred value.
ClickHouseDnsResolver	Default DNS resolver.
ClickHouseEnum
ClickHouseFile	Wrapper of File with additional information like compression and format.
ClickHouseInputStream	Extended input stream for read optimization.
ClickHouseLoadBalancingPolicy	Load balancing policy.
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.
ClickHouseNodes	A generic node manager for managing one or more nodes which may or may not belong to same cluster.
ClickHouseNodeSelector	This class maintains two immutable collections: preferred protocols and tags.
ClickHouseOutputStream	Extended output stream for write optimization.
ClickHouseParameterizedQuery	A parameterized query is a parsed query with parameters being extracted for substitution.
ClickHouseParameterizedQuery.QueryPart	A part of query.
ClickHousePipedOutputStream	SPSC(Single-producer single-consumer) channel for streaming.
ClickHouseRequest<SelfT extends ClickHouseRequest<SelfT>>	Request object holding references to ClickHouseClient, ClickHouseNode, format, sql, options and settings etc.
ClickHouseRequest.Mutation	Mutation request.
ClickHouseRequestManager	Request manager is responsible for generating query and session ID, as well as transaction creation.
ClickHouseResponseSummary	Summary of ClickHouse response.
ClickHouseResponseSummary.Progress	Progress of a query.
ClickHouseResponseSummary.Statistics	Statistics of a query.
ClickHouseThreadFactory
ClickHouseTransaction	This class represents a transaction in ClickHouse.
ClickHouseTransaction.XID	This class encapsulates transaction ID, which is defined as Tuple(snapshotVersion UInt64, localTxCounter UInt64, hostId UUID).
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
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.
ClickHouseTransactionException