Package com.clickhouse.jdbc

Interface ClickHouseConnection

All Superinterfaces:

AutoCloseable, Connection, Wrapper

All Known Implementing Classes:

ClickHouseConnectionImpl

public interface ClickHouseConnection
extends Connection

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMN_ARRAY
static final String	COLUMN_ELEMENT
static final String	PROP_APPLICATION_NAME
static final String	PROP_CUSTOM_HTTP_HEADERS
static final String	PROP_CUSTOM_HTTP_PARAMS

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

Modifier and Type	Method	Description
boolean	allowCustomSetting()	Checks whether custom setting is allowed or not.
void	begin()	Starts a new transaction.
default ClickHouseArray	createArrayOf(String typeName, Object[] elements)
default ClickHouseBlob	createBlob()
default ClickHouseClob	createClob()
default ClickHouseXml	createSQLXML()
default ClickHouseStatement	createStatement()
default ClickHouseStatement	createStatement(int resultSetType, int resultSetConcurrency)
ClickHouseStatement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
default ClickHouseStruct	createStruct(String typeName, Object[] attributes)
com.clickhouse.client.ClickHouseConfig	getConfig()	Gets configuration tied to this connection.
String	getCurrentDatabase()	Gets current database.
String	getCurrentUser()	Gets current user.
Calendar	getDefaultCalendar()	Gets default calendar which can be used to create timestamp.
Optional<TimeZone>	getEffectiveTimeZone()	Gets effective time zone.
JdbcConfig	getJdbcConfig()	Gets JDBC-specific configuration.
default JdbcTypeMapping	getJdbcTypeMapping()	Gets JDBC type mapping.
TimeZone	getJvmTimeZone()	Gets cached value of TimeZone.getDefault().
long	getMaxInsertBlockSize()	Gets max insert block size.
TimeZone	getServerTimeZone()	Gets server time zone, which is either same as result of select timezone(), or the overrided value from ClickHouseConfig.getServerTimeZone().
com.clickhouse.data.ClickHouseVersion	getServerVersion()	Gets server version.
com.clickhouse.client.ClickHouseTransaction	getTransaction()	Gets current transaction.
URI	getUri()	Gets URI of the connection.
boolean	isImplicitTransactionSupported()	Checks whether implicit transaction is supported.
boolean	isTransactionSupported()	Checks whether transaction is supported.
String	newQueryId()	Creates a new query ID.
default ClickHouseSqlStatement[]	parse(String sql, com.clickhouse.client.ClickHouseConfig config)	Deprecated. will be removed in 0.5, please use parse(String, ClickHouseConfig, Map) instead
ClickHouseSqlStatement[]	parse(String sql, com.clickhouse.client.ClickHouseConfig config, Map<String,Serializable> settings)	Parses the given sql.
default CallableStatement	prepareCall(String sql)
default CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
default CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
default PreparedStatement	prepareStatement(String sql)
default PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
default PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
default PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
default PreparedStatement	prepareStatement(String sql, String[] columnNames)
void	setCurrentDatabase(String database, boolean check)	Sets current database.

Methods inherited from interface java.sql.Connection

abort, beginRequest, clearWarnings, close, commit, createNClob, endRequest, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getNetworkTimeout, getSchema, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setNetworkTimeout, setReadOnly, setSavepoint, setSavepoint, setSchema, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Details

COLUMN_ELEMENT

static final String COLUMN_ELEMENT

See Also:

• Constant Field Values

COLUMN_ARRAY

static final String COLUMN_ARRAY

See Also:

• Constant Field Values

PROP_APPLICATION_NAME

static final String PROP_APPLICATION_NAME

See Also:

• Constant Field Values

PROP_CUSTOM_HTTP_HEADERS

static final String PROP_CUSTOM_HTTP_HEADERS

See Also:

• Constant Field Values

PROP_CUSTOM_HTTP_PARAMS

static final String PROP_CUSTOM_HTTP_PARAMS

See Also:

• Constant Field Values

Method Details

createArrayOf

default ClickHouseArray createArrayOf(String typeName,
 Object[] elements)
                               throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createBlob

default ClickHouseBlob createBlob()
                           throws SQLException

Specified by:

createBlob in interface Connection

Throws:

SQLException

createClob

default ClickHouseClob createClob()
                           throws SQLException

Specified by:

createClob in interface Connection

Throws:

SQLException

createStruct

default ClickHouseStruct createStruct(String typeName,
 Object[] attributes)
                               throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

createSQLXML

default ClickHouseXml createSQLXML()
                            throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

createStatement

default ClickHouseStatement createStatement()
                                     throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

default ClickHouseStatement createStatement(int resultSetType,
 int resultSetConcurrency)
                                     throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

ClickHouseStatement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                             throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareCall

default CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                               throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int autoGeneratedKeys)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int[] columnIndexes)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 String[] columnNames)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

default PreparedStatement prepareStatement(String sql,
 int resultSetType,
 int resultSetConcurrency)
                                    throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

begin

void begin()
    throws SQLException

Starts a new transaction. It's no-op for a newly started transaction.

Throws:

SQLException - when current transaction is active state or not able to start new transaction

getConfig

com.clickhouse.client.ClickHouseConfig getConfig()

Gets configuration tied to this connection.

Returns:

non-null configuration

allowCustomSetting

boolean allowCustomSetting()

Checks whether custom setting is allowed or not.

Returns:

true if custom setting is allowed; false otherwise

getCurrentDatabase

String getCurrentDatabase()

Gets current database. Connection.getSchema() is similar but it will check if connection is closed or not hence may throw SQLException.

Returns:

non-null database name

setCurrentDatabase

void setCurrentDatabase(String database,
 boolean check)
                 throws SQLException

Sets current database.

Parameters:

database - non-empty database name

check - whether to check if the database exists or not

Throws:

SQLException - when failed to change current database

getCurrentUser

String getCurrentUser()

Gets current user.

Returns:

non-null user name

getDefaultCalendar

Calendar getDefaultCalendar()

Gets default calendar which can be used to create timestamp.

Returns:

non-null calendar

getEffectiveTimeZone

Optional<TimeZone> getEffectiveTimeZone()

Gets effective time zone. When ClickHouseConfig.isUseServerTimeZone() returns false, ClickHouseConfig.getUseTimeZone() will be used as effective time zone, which will be used for reading and writing timestamp values.

Returns:

effective time zone

getJvmTimeZone

TimeZone getJvmTimeZone()

Gets cached value of TimeZone.getDefault().

Returns:

non-null cached JVM time zone

getServerTimeZone

TimeZone getServerTimeZone()

Gets server time zone, which is either same as result of select timezone(), or the overrided value from ClickHouseConfig.getServerTimeZone().

Returns:

non-null server time zone

getServerVersion

com.clickhouse.data.ClickHouseVersion getServerVersion()

Gets server version.

Returns:

non-null server version

getTransaction

com.clickhouse.client.ClickHouseTransaction getTransaction()

Gets current transaction.

Returns:

current transaction, which could be null

getUri

URI getUri()

Gets URI of the connection.

Returns:

URI of the connection

getJdbcConfig

JdbcConfig getJdbcConfig()

Gets JDBC-specific configuration.

Returns:

non-null JDBC-specific configuration

getJdbcTypeMapping

default JdbcTypeMapping getJdbcTypeMapping()

Gets JDBC type mapping. Same as getJdbcConfig().getMapper().

Returns:

non-null JDBC type mapping

getMaxInsertBlockSize

long getMaxInsertBlockSize()

Gets max insert block size. Pay attention that INSERT into one partition in one table of MergeTree family up to max_insert_block_size rows is transactional.

Returns:

value of max_insert_block_size

isTransactionSupported

boolean isTransactionSupported()

Checks whether transaction is supported.

Returns:

true if transaction is supported; false otherwise

isImplicitTransactionSupported

boolean isImplicitTransactionSupported()

Checks whether implicit transaction is supported.

Returns:

true if implicit transaction is supported; false otherwise

newQueryId

String newQueryId()

Creates a new query ID.

Returns:

universal unique query ID

parse

@Deprecated
default ClickHouseSqlStatement[] parse(String sql,
 com.clickhouse.client.ClickHouseConfig config)

Deprecated.

will be removed in 0.5, please use parse(String, ClickHouseConfig, Map) instead

Parses the given sql.

Parameters:

sql - sql to parse

config - configuration which might be used for parsing, could be null

Returns:

non-null parsed sql statements

parse

ClickHouseSqlStatement[] parse(String sql,
 com.clickhouse.client.ClickHouseConfig config,
 Map<String,Serializable> settings)

Parses the given sql.

Parameters:

sql - sql to parse

config - configuration which might be used for parsing, could be null

settings - server settings

Returns:

non-null parsed sql statements