com.clickhouse.jdbc.ClickHouseDriver Maven / Gradle / Ivy
package com.clickhouse.jdbc;
import java.io.Serializable;
import java.sql.Driver;
import java.sql.DriverManager;
import java.sql.DriverPropertyInfo;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.Map.Entry;
import com.clickhouse.client.ClickHouseClient;
import com.clickhouse.client.ClickHouseVersion;
import com.clickhouse.client.config.ClickHouseClientOption;
import com.clickhouse.client.config.ClickHouseOption;
import com.clickhouse.client.logging.Logger;
import com.clickhouse.client.logging.LoggerFactory;
import com.clickhouse.jdbc.internal.ClickHouseConnectionImpl;
import com.clickhouse.jdbc.internal.ClickHouseJdbcUrlParser;
/**
* JDBC driver for ClickHouse. It takes a connection string like below for
* connecting to ClickHouse server:
* {@code jdbc:clickhouse://[:@][:][/][?parameter1=value1¶meter2=value2]}
*
*
* For examples:
*
* - {@code jdbc:clickhouse://localhost:8123/system}
* - {@code jdbc:clickhouse://admin:password@localhost/system?socket_time=30}
* - {@code jdbc:clickhouse://localhost/system?protocol=grpc}
*
*/
public class ClickHouseDriver implements Driver {
private static final Logger log = LoggerFactory.getLogger(ClickHouseDriver.class);
private static final Map clientSpecificOptions;
static final String driverVersionString;
static final ClickHouseVersion driverVersion;
static final ClickHouseVersion specVersion;
static final java.util.logging.Logger parentLogger = java.util.logging.Logger.getLogger("com.clickhouse.jdbc");
static {
driverVersionString = ClickHouseDriver.class.getPackage().getImplementationVersion();
driverVersion = ClickHouseVersion.of(driverVersionString);
specVersion = ClickHouseVersion.of(ClickHouseDriver.class.getPackage().getSpecificationVersion());
try {
DriverManager.registerDriver(new ClickHouseDriver());
} catch (SQLException e) {
throw new IllegalStateException(e);
}
log.debug("ClickHouse Driver %s(JDBC: %s) registered", driverVersion, specVersion);
// client-specific options
Map m = new LinkedHashMap<>();
try {
for (ClickHouseClient c : ServiceLoader.load(ClickHouseClient.class,
ClickHouseDriver.class.getClassLoader())) {
Class clazz = c.getOptionClass();
if (clazz == null || clazz == ClickHouseClientOption.class) {
continue;
}
for (ClickHouseOption o : clazz.getEnumConstants()) {
m.put(o.getKey(), o);
}
}
} catch (Exception e) {
log.warn("Failed to load client-specific options", e);
}
clientSpecificOptions = Collections.unmodifiableMap(m);
}
public static Map toClientOptions(Properties props) {
if (props == null || props.isEmpty()) {
return Collections.emptyMap();
}
Map options = new HashMap<>();
for (Entry e : props.entrySet()) {
if (e.getKey() == null || e.getValue() == null) {
continue;
}
String key = e.getKey().toString();
ClickHouseOption o = ClickHouseClientOption.fromKey(key);
if (o == null) {
o = clientSpecificOptions.get(key);
}
if (o != null) {
options.put(o, ClickHouseOption.fromString(e.getValue().toString(), o.getValueType()));
}
}
return options;
}
private DriverPropertyInfo create(ClickHouseOption option, Properties props) {
DriverPropertyInfo propInfo = new DriverPropertyInfo(option.getKey(),
props.getProperty(option.getKey(), String.valueOf(option.getEffectiveDefaultValue())));
propInfo.required = false;
propInfo.description = option.getDescription();
propInfo.choices = null;
Class clazz = option.getValueType();
if (Boolean.class == clazz || boolean.class == clazz) {
propInfo.choices = new String[] { "true", "false" };
} else if (clazz.isEnum()) {
Object[] values = clazz.getEnumConstants();
String[] names = new String[values.length];
int index = 0;
for (Object v : values) {
names[index++] = ((Enum) v).name();
}
propInfo.choices = names;
}
return propInfo;
}
@Override
public boolean acceptsURL(String url) throws SQLException {
return url != null && (url.startsWith(ClickHouseJdbcUrlParser.JDBC_CLICKHOUSE_PREFIX)
|| url.startsWith(ClickHouseJdbcUrlParser.JDBC_ABBREVIATION_PREFIX));
}
@Override
public ClickHouseConnection connect(String url, Properties info) throws SQLException {
if (!acceptsURL(url)) {
return null;
}
log.debug("Creating connection");
return new ClickHouseConnectionImpl(url, info);
}
@Override
public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws SQLException {
try {
info = ClickHouseJdbcUrlParser.parse(url, info).getProperties();
} catch (Exception e) {
log.error("Could not parse url %s", url, e);
}
List result = new ArrayList<>(ClickHouseClientOption.values().length * 2);
for (ClickHouseClientOption option : ClickHouseClientOption.values()) {
result.add(create(option, info));
}
// and then client-specific options
for (ClickHouseOption option : clientSpecificOptions.values()) {
result.add(create(option, info));
}
result.addAll(JdbcConfig.getDriverProperties());
return result.toArray(new DriverPropertyInfo[0]);
}
@Override
public int getMajorVersion() {
return driverVersion.getMajorVersion();
}
@Override
public int getMinorVersion() {
return driverVersion.getMinorVersion();
}
@Override
public boolean jdbcCompliant() {
return false;
}
@Override
public java.util.logging.Logger getParentLogger() throws SQLFeatureNotSupportedException {
return parentLogger;
}
}