Package com.clickhouse.client.http

Class ClickHouseHttpConnection

java.lang.Object

com.clickhouse.client.http.ClickHouseHttpConnection

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ApacheHttpConnectionImpl, HttpUrlConnectionImpl

public abstract class ClickHouseHttpConnection
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClickHouseConfig	config
protected final Map<String,String>	defaultHeaders
protected final ClickHouseRequestManager	rm
protected final ClickHouseNode	server
protected final String	url

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ClickHouseHttpConnection(ClickHouseNode server, ClickHouseRequest<?> request, Map<String,Serializable> additionalParams)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	closeQuietly()
protected static Map<String,String>	createDefaultHeaders(ClickHouseConfig config, ClickHouseNode server, String userAgent, String referer)
protected String	getBaseUrl()
protected String	getDefaultUserAgent()
protected static Proxy	getProxy(ClickHouseConfig config)
protected final String	getUserAgent()
protected boolean	isReusable()	Checks whether the connection is reusable or not.
protected Map<String,String>	mergeHeaders(Map<String,String> requestHeaders)	Creates a merged map.
protected static String	parseErrorFromException(String errorCode, String serverName, IOException e, byte[] bytes)
abstract boolean	ping(int timeout)	Sends a request to <baseUrl>/ping for liveness detection.
protected abstract ClickHouseHttpResponse	post(ClickHouseConfig config, String query, com.clickhouse.data.ClickHouseInputStream data, List<com.clickhouse.data.ClickHouseExternalTable> tables, com.clickhouse.data.ClickHouseOutputStream output, String url, Map<String,String> headers, Runnable postCloseAction)	Posts query and data to server.
protected static void	postData(ClickHouseConfig config, byte[] boundary, String sql, com.clickhouse.data.ClickHouseInputStream data, List<com.clickhouse.data.ClickHouseExternalTable> tables, OutputStream requestStream)
ClickHouseHttpResponse	query(String query)
ClickHouseHttpResponse	query(String query, List<com.clickhouse.data.ClickHouseExternalTable> tables)
ClickHouseHttpResponse	query(String query, List<com.clickhouse.data.ClickHouseExternalTable> tables, Map<String,String> headers)
ClickHouseHttpResponse	query(String query, Map<String,String> headers)
ClickHouseHttpResponse	update(String query)
ClickHouseHttpResponse	update(String query, com.clickhouse.data.ClickHouseInputStream data)
ClickHouseHttpResponse	update(String query, com.clickhouse.data.ClickHouseInputStream data, Map<String,String> headers)
ClickHouseHttpResponse	update(String query, Map<String,String> headers)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

server

protected final ClickHouseNode server

rm

protected final ClickHouseRequestManager rm

config

protected final ClickHouseConfig config

defaultHeaders

protected final Map<String,String> defaultHeaders

url

protected final String url

Constructor Details

ClickHouseHttpConnection

protected ClickHouseHttpConnection(ClickHouseNode server,
 ClickHouseRequest<?> request,
 Map<String,Serializable> additionalParams)

Method Details

createDefaultHeaders

protected static Map<String,String> createDefaultHeaders(ClickHouseConfig config,
 ClickHouseNode server,
 String userAgent,
 String referer)

getProxy

protected static Proxy getProxy(ClickHouseConfig config)

parseErrorFromException

protected static String parseErrorFromException(String errorCode,
 String serverName,
 IOException e,
 byte[] bytes)

postData

protected static void postData(ClickHouseConfig config,
 byte[] boundary,
 String sql,
 com.clickhouse.data.ClickHouseInputStream data,
 List<com.clickhouse.data.ClickHouseExternalTable> tables,
 OutputStream requestStream)
                        throws IOException

Throws:

IOException

closeQuietly

protected void closeQuietly()

getBaseUrl

protected String getBaseUrl()

getDefaultUserAgent

protected String getDefaultUserAgent()

getUserAgent

protected final String getUserAgent()

mergeHeaders

protected Map<String,String> mergeHeaders(Map<String,String> requestHeaders)

Creates a merged map.

Parameters:

requestHeaders - request headers

Returns:

non-null merged headers

post

protected abstract ClickHouseHttpResponse post(ClickHouseConfig config,
 String query,
 com.clickhouse.data.ClickHouseInputStream data,
 List<com.clickhouse.data.ClickHouseExternalTable> tables,
 com.clickhouse.data.ClickHouseOutputStream output,
 String url,
 Map<String,String> headers,
 Runnable postCloseAction)
                                        throws IOException

Posts query and data to server.

Parameters:

query - non-blank query

config - non-null configuration

data - optionally input stream for batch updating

tables - optionally external tables for query

output - optionally output stream

url - optionally url

headers - optionally request headers

postCloseAction - optionally post action

Returns:

response

Throws:

IOException - when error occured posting request and/or server failed to respond

isReusable

protected boolean isReusable()

Checks whether the connection is reusable or not. This method will be called in ClickHouseHttpClient.checkConnection(ClickHouseHttpConnection, ClickHouseNode, ClickHouseNode, ClickHouseRequest) for making a decision of whether to create a new connection. In addition to that, if a connection is NOT reusable, it will be closed right after corresponding ClickHouseResponse is closed.

Returns:

true if it's reusable; false otherwise

ping

public abstract boolean ping(int timeout)

Sends a request to <baseUrl>/ping for liveness detection.

Parameters:

timeout - timeout in millisecond

Returns:

true if server responded Ok.; false otherwise

update

public ClickHouseHttpResponse update(String query)
                              throws IOException

Throws:

IOException

update

public ClickHouseHttpResponse update(String query,
 Map<String,String> headers)
                              throws IOException

Throws:

IOException

update

public ClickHouseHttpResponse update(String query,
 com.clickhouse.data.ClickHouseInputStream data)
                              throws IOException

Throws:

IOException

update

public ClickHouseHttpResponse update(String query,
 com.clickhouse.data.ClickHouseInputStream data,
 Map<String,String> headers)
                              throws IOException

Throws:

IOException

query

public ClickHouseHttpResponse query(String query)
                             throws IOException

Throws:

IOException

query

public ClickHouseHttpResponse query(String query,
 Map<String,String> headers)
                             throws IOException

Throws:

IOException

query

public ClickHouseHttpResponse query(String query,
 List<com.clickhouse.data.ClickHouseExternalTable> tables)
                             throws IOException

Throws:

IOException

query

public ClickHouseHttpResponse query(String query,
 List<com.clickhouse.data.ClickHouseExternalTable> tables,
 Map<String,String> headers)
                             throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException