com.github.housepower.settings.ClickHouseConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of clickhouse-native-jdbc Show documentation
Show all versions of clickhouse-native-jdbc Show documentation
ClickHouse Native Protocol JDBC implementation
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.housepower.settings;
import com.github.housepower.jdbc.ClickhouseJdbcUrlParser;
import com.github.housepower.misc.CollectionUtil;
import com.github.housepower.misc.StrUtil;
import javax.annotation.concurrent.Immutable;
import java.io.Serializable;
import java.nio.charset.Charset;
import java.time.Duration;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
@Immutable
public class ClickHouseConfig implements Serializable {
private final String host;
private final int port;
private final String database;
private final String user;
private final String password;
private final Duration queryTimeout;
private final Duration connectTimeout;
private final String charset; // use String because Charset is not serializable
private final Map settings;
private final boolean tcpKeepAlive;
private final String clientName;
private ClickHouseConfig(String host, int port, String database, String user, String password,
Duration queryTimeout, Duration connectTimeout, boolean tcpKeepAlive,
String charset, String clientName, Map settings) {
this.host = host;
this.port = port;
this.database = database;
this.user = user;
this.password = password;
this.queryTimeout = queryTimeout;
this.connectTimeout = connectTimeout;
this.tcpKeepAlive = tcpKeepAlive;
this.charset = charset;
this.clientName = clientName;
this.settings = settings;
}
public String host() {
return this.host;
}
public int port() {
return this.port;
}
public String database() {
return this.database;
}
public String user() {
return this.user;
}
public String password() {
return this.password;
}
public Duration queryTimeout() {
return this.queryTimeout;
}
public Duration connectTimeout() {
return this.connectTimeout;
}
public Charset charset() {
return Charset.forName(charset);
}
public String clientName() {
return this.clientName;
}
public String jdbcUrl() {
StringBuilder builder = new StringBuilder(ClickhouseJdbcUrlParser.JDBC_CLICKHOUSE_PREFIX)
.append("//").append(host).append(":").append(port).append("/").append(database)
.append("?").append(SettingKey.query_timeout.name()).append("=").append(queryTimeout.getSeconds())
.append("&").append(SettingKey.connect_timeout.name()).append("=").append(connectTimeout.getSeconds())
.append("&").append(SettingKey.charset.name()).append("=").append(charset)
.append("&").append(SettingKey.client_name.name()).append("=").append(clientName)
.append("&").append(SettingKey.tcp_keep_alive.name()).append("=").append(tcpKeepAlive);
for (Map.Entry entry : settings.entrySet()) {
builder.append("&").append(entry.getKey().name()).append("=").append(entry.getValue());
}
return builder.toString();
}
public Map settings() {
return settings;
}
public ClickHouseConfig withHostPort(String host, int port) {
return Builder.builder(this)
.host(host)
.port(port)
.build();
}
public ClickHouseConfig withDatabase(String database) {
return Builder.builder(this)
.database(database)
.build();
}
public ClickHouseConfig withCredentials(String user, String password) {
return Builder.builder(this)
.user(user)
.password(password)
.build();
}
public ClickHouseConfig withQueryTimeout(Duration timeout) {
return Builder.builder(this)
.queryTimeout(timeout)
.build();
}
public ClickHouseConfig withTcpKeepAlive(boolean enable) {
return Builder.builder(this)
.tcpKeepAlive(enable)
.build();
}
public ClickHouseConfig withCharset(Charset charset) {
return Builder.builder(this)
.charset(charset)
.build();
}
public ClickHouseConfig withClientName(String clientName) {
return Builder.builder(this)
.clientName(clientName)
.build();
}
public ClickHouseConfig withSettings(Map settings) {
return Builder.builder(this)
.withSettings(settings)
.build();
}
public ClickHouseConfig withJdbcUrl(String url) {
return Builder.builder(this)
.withJdbcUrl(url)
.build();
}
public ClickHouseConfig withProperties(Properties properties) {
return Builder.builder(this)
.withProperties(properties)
.build();
}
public ClickHouseConfig with(String url, Properties properties) {
return Builder.builder(this)
.withJdbcUrl(url)
.withProperties(properties)
.build();
}
public boolean tcpKeepAlive() {
return tcpKeepAlive;
}
public static final class Builder {
private String host;
private int port;
private String database;
private String user;
private String password;
private Duration connectTimeout;
private Duration queryTimeout;
private boolean tcpKeepAlive;
private Charset charset;
private String clientName;
private Map settings = new HashMap<>();
private Builder() {
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ClickHouseConfig cfg) {
return new Builder()
.host(cfg.host())
.port(cfg.port())
.database(cfg.database())
.user(cfg.user())
.password(cfg.password())
.connectTimeout(cfg.connectTimeout())
.queryTimeout(cfg.queryTimeout())
.charset(cfg.charset())
.tcpKeepAlive(cfg.tcpKeepAlive())
.clientName(cfg.clientName())
.withSettings(cfg.settings());
}
public Builder withSetting(SettingKey key, Serializable value) {
this.settings.put(key, value);
return this;
}
public Builder withSettings(Map settings) {
CollectionUtil.mergeMapInPlaceKeepLast(this.settings, settings);
return this;
}
public Builder host(String host) {
this.withSetting(SettingKey.host, host);
return this;
}
public Builder port(int port) {
this.withSetting(SettingKey.port, port);
return this;
}
public Builder database(String database) {
this.withSetting(SettingKey.database, database);
return this;
}
public Builder user(String user) {
this.withSetting(SettingKey.user, user);
return this;
}
public Builder password(String password) {
this.withSetting(SettingKey.password, password);
return this;
}
public Builder connectTimeout(Duration connectTimeout) {
this.withSetting(SettingKey.connect_timeout, connectTimeout);
return this;
}
public Builder queryTimeout(Duration queryTimeout) {
this.withSetting(SettingKey.query_timeout, queryTimeout);
return this;
}
public Builder tcpKeepAlive(boolean tcpKeepAlive) {
this.withSetting(SettingKey.tcp_keep_alive, tcpKeepAlive);
return this;
}
public Builder charset(String charset) {
this.withSetting(SettingKey.charset, charset);
return this;
}
public Builder charset(Charset charset) {
this.withSetting(SettingKey.charset, charset.name());
return this;
}
public Builder clientName(String clientName) {
this.withSetting(SettingKey.client_name, clientName);
return this;
}
public Builder settings(Map settings) {
this.settings = settings;
return this;
}
public Builder clearSettings() {
this.settings = new HashMap<>();
return this;
}
public Builder withJdbcUrl(String jdbcUrl) {
return this.withSettings(ClickhouseJdbcUrlParser.parseJdbcUrl(jdbcUrl));
}
public Builder withProperties(Properties properties) {
return this.withSettings(ClickhouseJdbcUrlParser.parseProperties(properties));
}
public ClickHouseConfig build() {
this.host = (String) this.settings.getOrDefault(SettingKey.host, "127.0.0.1");
this.port = ((Number) this.settings.getOrDefault(SettingKey.port, 9000)).intValue();
this.user = (String) this.settings.getOrDefault(SettingKey.user, "default");
this.password = (String) this.settings.getOrDefault(SettingKey.password, "");
this.database = (String) this.settings.getOrDefault(SettingKey.database, "default");
this.connectTimeout = (Duration) this.settings.getOrDefault(SettingKey.connect_timeout, Duration.ZERO);
this.queryTimeout = (Duration) this.settings.getOrDefault(SettingKey.query_timeout, Duration.ZERO);
this.tcpKeepAlive = (boolean) this.settings.getOrDefault(SettingKey.tcp_keep_alive, false);
this.charset = Charset.forName((String) this.settings.getOrDefault(SettingKey.charset, "UTF-8"));
this.clientName = (String) this.settings.getOrDefault(SettingKey.client_name,
String.format(Locale.ROOT, "%s %s", ClickHouseDefines.NAME, "client"));
revisit();
purgeSettings();
return new ClickHouseConfig(
host, port, database, user, password, queryTimeout, connectTimeout, tcpKeepAlive, charset.name(), clientName, settings);
}
private void revisit() {
if (StrUtil.isBlank(this.host)) this.host = "127.0.0.1";
if (this.port == -1) this.port = 9000;
if (StrUtil.isBlank(this.user)) this.user = "default";
if (StrUtil.isBlank(this.password)) this.password = "";
if (StrUtil.isBlank(this.database)) this.database = "default";
if (this.queryTimeout.isNegative()) this.queryTimeout = Duration.ZERO;
if (this.connectTimeout.isNegative()) this.connectTimeout = Duration.ZERO;
}
private void purgeSettings() {
this.settings.remove(SettingKey.port);
this.settings.remove(SettingKey.host);
this.settings.remove(SettingKey.password);
this.settings.remove(SettingKey.user);
this.settings.remove(SettingKey.database);
this.settings.remove(SettingKey.query_timeout);
this.settings.remove(SettingKey.connect_timeout);
this.settings.remove(SettingKey.tcp_keep_alive);
this.settings.remove(SettingKey.charset);
this.settings.remove(SettingKey.client_name);
}
}
}