PrestoConnection.java
/*
* 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.facebook.presto.jdbc;
import com.facebook.presto.client.ClientSession;
import com.facebook.presto.client.ServerInfo;
import com.facebook.presto.client.StatementClient;
import com.facebook.presto.spi.security.SelectedRole;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Splitter;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.primitives.Ints;
import io.airlift.units.Duration;
import java.net.URI;
import java.nio.charset.CharsetEncoder;
import java.sql.Array;
import java.sql.Blob;
import java.sql.CallableStatement;
import java.sql.Clob;
import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.NClob;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLClientInfoException;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.sql.SQLWarning;
import java.sql.SQLXML;
import java.sql.Savepoint;
import java.sql.Statement;
import java.sql.Struct;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.Executor;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Strings.nullToEmpty;
import static com.google.common.collect.Maps.fromProperties;
import static java.lang.String.format;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static java.util.Objects.requireNonNull;
import static java.util.concurrent.TimeUnit.DAYS;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
import static java.util.concurrent.TimeUnit.MINUTES;
public class PrestoConnection
implements Connection
{
private final AtomicBoolean closed = new AtomicBoolean();
private final AtomicBoolean autoCommit = new AtomicBoolean(true);
private final AtomicInteger isolationLevel = new AtomicInteger(TRANSACTION_READ_UNCOMMITTED);
private final AtomicBoolean readOnly = new AtomicBoolean();
private final AtomicReference<String> catalog = new AtomicReference<>();
private final AtomicReference<String> schema = new AtomicReference<>();
private final AtomicReference<String> timeZoneId = new AtomicReference<>();
private final AtomicReference<Locale> locale = new AtomicReference<>();
private final AtomicReference<Integer> networkTimeoutMillis = new AtomicReference<>(Ints.saturatedCast(MINUTES.toMillis(2)));
private final AtomicReference<ServerInfo> serverInfo = new AtomicReference<>();
private final AtomicLong nextStatementId = new AtomicLong(1);
private final URI jdbcUri;
private final URI httpUri;
private final String user;
private final boolean compressionDisabled;
private final Map<String, String> extraCredentials;
private final Map<String, String> customHeaders;
private final Map<String, String> sessionProperties;
private final Properties connectionProperties;
private final Optional<String> applicationNamePrefix;
private final Map<String, String> clientInfo = new ConcurrentHashMap<>();
private final Map<String, String> preparedStatements = new ConcurrentHashMap<>();
private final Map<String, SelectedRole> roles = new ConcurrentHashMap<>();
private final AtomicReference<String> transactionId = new AtomicReference<>();
private final QueryExecutor queryExecutor;
private final WarningsManager warningsManager = new WarningsManager();
private final List<QueryInterceptor> queryInterceptorInstances;
private final boolean validateNextUriSource;
PrestoConnection(PrestoDriverUri uri, QueryExecutor queryExecutor)
throws SQLException
{
requireNonNull(uri, "uri is null");
this.jdbcUri = uri.getJdbcUri();
this.httpUri = uri.getHttpUri();
this.schema.set(uri.getSchema());
this.catalog.set(uri.getCatalog());
this.user = uri.getUser();
this.applicationNamePrefix = uri.getApplicationNamePrefix();
this.compressionDisabled = uri.isCompressionDisabled();
this.extraCredentials = uri.getExtraCredentials();
this.customHeaders = uri.getCustomHeaders();
this.sessionProperties = new ConcurrentHashMap<>(uri.getSessionProperties());
this.connectionProperties = uri.getProperties();
this.queryExecutor = requireNonNull(queryExecutor, "queryExecutor is null");
this.validateNextUriSource = uri.validateNextUriSource();
uri.getClientTags().ifPresent(tags -> clientInfo.put("ClientTags", tags));
timeZoneId.set(uri.getTimeZoneId());
locale.set(Locale.getDefault());
this.queryInterceptorInstances = ImmutableList.copyOf(uri.getQueryInterceptors());
initializeQueryInterceptors();
}
public static PrestoConnection newConnectionWithSessionProperties(PrestoConnection connectionWithSessionProperties, Properties connectionProperties)
throws SQLException
{
requireNonNull(connectionWithSessionProperties, "connectionWithSessionProperties is null");
URI connectionWithSessionPropertiesURI = connectionWithSessionProperties.getURI();
String prestoUrl = format("%s://%s:%s%s", connectionWithSessionPropertiesURI.getScheme(), connectionWithSessionPropertiesURI.getHost(), connectionWithSessionPropertiesURI.getPort(), connectionWithSessionPropertiesURI.getPath());
PrestoDriverUri uri = new PrestoDriverUri(prestoUrl, connectionProperties);
PrestoConnection prestoConnection = new PrestoConnection(uri, connectionWithSessionProperties.queryExecutor);
copySessionProperties(connectionWithSessionProperties, prestoConnection);
return prestoConnection;
}
public static void copySessionProperties(PrestoConnection src, PrestoConnection dst)
{
requireNonNull(src, "src is null");
requireNonNull(dst, "dst is null");
Map<String, String> map = src.getSessionProperties();
map.forEach(dst::setSessionProperty);
}
@Override
public Statement createStatement()
throws SQLException
{
checkOpen();
return new PrestoStatement(this);
}
@Override
public PreparedStatement prepareStatement(String sql)
throws SQLException
{
checkOpen();
String name = "statement" + nextStatementId.getAndIncrement();
return new PrestoPreparedStatement(this, name, sql);
}
@Override
public CallableStatement prepareCall(String sql)
throws SQLException
{
throw new NotImplementedException("Connection", "prepareCall");
}
@Override
public String nativeSQL(String sql)
throws SQLException
{
checkOpen();
return sql;
}
@Override
public void setAutoCommit(boolean autoCommit)
throws SQLException
{
checkOpen();
boolean wasAutoCommit = this.autoCommit.get();
if (autoCommit && !wasAutoCommit) {
commit();
}
this.autoCommit.set(autoCommit);
}
@Override
public boolean getAutoCommit()
throws SQLException
{
checkOpen();
return autoCommit.get();
}
@Override
public void commit()
throws SQLException
{
checkOpen();
if (getAutoCommit()) {
throw new SQLException("Connection is in auto-commit mode");
}
if (transactionId.get() == null) {
return;
}
try (PrestoStatement statement = new PrestoStatement(this)) {
statement.internalExecute("COMMIT");
}
}
@Override
public void rollback()
throws SQLException
{
checkOpen();
if (getAutoCommit()) {
throw new SQLException("Connection is in auto-commit mode");
}
if (transactionId.get() == null) {
return;
}
try (PrestoStatement statement = new PrestoStatement(this)) {
statement.internalExecute("ROLLBACK");
}
}
@Override
public void close()
throws SQLException
{
try {
if (!closed.get() && (transactionId.get() != null)) {
try (PrestoStatement statement = new PrestoStatement(this)) {
statement.internalExecute("ROLLBACK");
}
}
}
finally {
closed.set(true);
Throwable innerException = null;
for (QueryInterceptor queryInterceptor : this.queryInterceptorInstances) {
try {
queryInterceptor.destroy();
}
catch (Throwable t) {
if (innerException == null) {
innerException = t;
}
else if (innerException != t) {
innerException.addSuppressed(t);
}
}
}
if (innerException != null) {
throw new RuntimeException(innerException);
}
}
}
@Override
public boolean isClosed()
throws SQLException
{
return closed.get();
}
@Override
public DatabaseMetaData getMetaData()
throws SQLException
{
return new PrestoDatabaseMetaData(this);
}
@Override
public void setReadOnly(boolean readOnly)
throws SQLException
{
checkOpen();
this.readOnly.set(readOnly);
}
@Override
public boolean isReadOnly()
throws SQLException
{
return readOnly.get();
}
@Override
public void setCatalog(String catalog)
throws SQLException
{
checkOpen();
this.catalog.set(catalog);
}
@Override
public String getCatalog()
throws SQLException
{
checkOpen();
return catalog.get();
}
@Override
public void setTransactionIsolation(int level)
throws SQLException
{
checkOpen();
getIsolationLevel(level);
isolationLevel.set(level);
}
@SuppressWarnings("MagicConstant")
@Override
public int getTransactionIsolation()
throws SQLException
{
checkOpen();
return isolationLevel.get();
}
@Override
public SQLWarning getWarnings()
throws SQLException
{
checkOpen();
return null;
}
@Override
public void clearWarnings()
throws SQLException
{
checkOpen();
}
@Override
public Statement createStatement(int resultSetType, int resultSetConcurrency)
throws SQLException
{
checkResultSet(resultSetType, resultSetConcurrency);
return createStatement();
}
@Override
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
throws SQLException
{
checkResultSet(resultSetType, resultSetConcurrency);
return prepareStatement(sql);
}
@Override
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency)
throws SQLException
{
checkResultSet(resultSetType, resultSetConcurrency);
throw new SQLFeatureNotSupportedException("prepareCall");
}
@Override
public Map<String, Class<?>> getTypeMap()
throws SQLException
{
throw new SQLFeatureNotSupportedException("getTypeMap");
}
@Override
public void setTypeMap(Map<String, Class<?>> map)
throws SQLException
{
throw new SQLFeatureNotSupportedException("setTypeMap");
}
@Override
public void setHoldability(int holdability)
throws SQLException
{
checkOpen();
if (holdability != ResultSet.HOLD_CURSORS_OVER_COMMIT) {
throw new SQLFeatureNotSupportedException("Changing holdability not supported");
}
}
@Override
public int getHoldability()
throws SQLException
{
checkOpen();
return ResultSet.HOLD_CURSORS_OVER_COMMIT;
}
@Override
public Savepoint setSavepoint()
throws SQLException
{
throw new SQLFeatureNotSupportedException("setSavepoint");
}
@Override
public Savepoint setSavepoint(String name)
throws SQLException
{
throw new SQLFeatureNotSupportedException("setSavepoint");
}
@Override
public void rollback(Savepoint savepoint)
throws SQLException
{
throw new SQLFeatureNotSupportedException("rollback");
}
@Override
public void releaseSavepoint(Savepoint savepoint)
throws SQLException
{
throw new SQLFeatureNotSupportedException("releaseSavepoint");
}
@Override
public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
throws SQLException
{
checkHoldability(resultSetHoldability);
return createStatement(resultSetType, resultSetConcurrency);
}
@Override
public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
throws SQLException
{
checkHoldability(resultSetHoldability);
return prepareStatement(sql, resultSetType, resultSetConcurrency);
}
@Override
public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
throws SQLException
{
checkHoldability(resultSetHoldability);
return prepareCall(sql, resultSetType, resultSetConcurrency);
}
@Override
public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys)
throws SQLException
{
if (autoGeneratedKeys != Statement.RETURN_GENERATED_KEYS) {
throw new SQLFeatureNotSupportedException("Auto generated keys must be NO_GENERATED_KEYS");
}
return prepareStatement(sql);
}
@Override
public PreparedStatement prepareStatement(String sql, int[] columnIndexes)
throws SQLException
{
throw new SQLFeatureNotSupportedException("prepareStatement");
}
@Override
public PreparedStatement prepareStatement(String sql, String[] columnNames)
throws SQLException
{
throw new SQLFeatureNotSupportedException("prepareStatement");
}
@Override
public Clob createClob()
throws SQLException
{
throw new SQLFeatureNotSupportedException("createClob");
}
@Override
public Blob createBlob()
throws SQLException
{
throw new SQLFeatureNotSupportedException("createBlob");
}
@Override
public NClob createNClob()
throws SQLException
{
throw new SQLFeatureNotSupportedException("createNClob");
}
@Override
public SQLXML createSQLXML()
throws SQLException
{
throw new SQLFeatureNotSupportedException("createSQLXML");
}
@Override
public boolean isValid(int timeout)
throws SQLException
{
if (timeout < 0) {
throw new SQLException("Timeout is negative");
}
return !isClosed();
}
@Override
public void setClientInfo(String name, String value)
throws SQLClientInfoException
{
requireNonNull(name, "name is null");
if (value != null) {
clientInfo.put(name, value);
}
else {
clientInfo.remove(name);
}
}
@Override
public void setClientInfo(Properties properties)
throws SQLClientInfoException
{
clientInfo.putAll(fromProperties(properties));
}
@Override
public String getClientInfo(String name)
throws SQLException
{
return clientInfo.get(name);
}
@Override
public Properties getClientInfo()
throws SQLException
{
Properties properties = new Properties();
for (Map.Entry<String, String> entry : clientInfo.entrySet()) {
properties.setProperty(entry.getKey(), entry.getValue());
}
return properties;
}
@Override
public Array createArrayOf(String typeName, Object[] elements)
throws SQLException
{
throw new SQLFeatureNotSupportedException("createArrayOf");
}
@Override
public Struct createStruct(String typeName, Object[] attributes)
throws SQLException
{
throw new SQLFeatureNotSupportedException("createStruct");
}
@Override
public void setSchema(String schema)
throws SQLException
{
checkOpen();
this.schema.set(schema);
}
@Override
public String getSchema()
throws SQLException
{
checkOpen();
return schema.get();
}
public Properties getConnectionProperties()
{
Properties properties = new Properties();
for (Map.Entry<Object, Object> entry : connectionProperties.entrySet()) {
properties.setProperty((String) entry.getKey(), (String) entry.getValue());
}
return properties;
}
public String getTimeZoneId()
{
return timeZoneId.get();
}
public void setTimeZoneId(String timeZoneId)
{
requireNonNull(timeZoneId, "timeZoneId is null");
this.timeZoneId.set(timeZoneId);
}
public Locale getLocale()
{
return locale.get();
}
public void setLocale(Locale locale)
{
this.locale.set(locale);
}
/**
* Adds a session property (experimental).
*/
public void setSessionProperty(String name, String value)
{
requireNonNull(name, "name is null");
requireNonNull(value, "value is null");
checkArgument(!name.isEmpty(), "name is empty");
CharsetEncoder charsetEncoder = US_ASCII.newEncoder();
checkArgument(name.indexOf('=') < 0, "Session property name must not contain '=': %s", name);
checkArgument(charsetEncoder.canEncode(name), "Session property name is not US_ASCII: %s", name);
checkArgument(charsetEncoder.canEncode(value), "Session property value is not US_ASCII: %s", value);
sessionProperties.put(name, value);
}
void setRole(String catalog, SelectedRole role)
{
requireNonNull(catalog, "catalog is null");
requireNonNull(role, "role is null");
roles.put(catalog, role);
}
@VisibleForTesting
Map<String, SelectedRole> getRoles()
{
return ImmutableMap.copyOf(roles);
}
@Override
public void abort(Executor executor)
throws SQLException
{
close();
}
@Override
public void setNetworkTimeout(Executor executor, int milliseconds)
throws SQLException
{
checkOpen();
if (milliseconds < 0) {
throw new SQLException("Timeout is negative");
}
networkTimeoutMillis.set(milliseconds);
}
@Override
public int getNetworkTimeout()
throws SQLException
{
checkOpen();
return networkTimeoutMillis.get();
}
@SuppressWarnings("unchecked")
@Override
public <T> T unwrap(Class<T> iface)
throws SQLException
{
if (isWrapperFor(iface)) {
return (T) this;
}
throw new SQLException("No wrapper for " + iface);
}
@Override
public boolean isWrapperFor(Class<?> iface)
throws SQLException
{
return iface.isInstance(this);
}
URI getURI()
{
return jdbcUri;
}
String getUser()
{
return user;
}
@VisibleForTesting
Map<String, String> getExtraCredentials()
{
return ImmutableMap.copyOf(extraCredentials);
}
Map<String, String> getSessionProperties()
{
return ImmutableMap.copyOf(sessionProperties);
}
@VisibleForTesting
public Map<String, String> getCustomHeaders()
{
return ImmutableMap.copyOf(customHeaders);
}
ServerInfo getServerInfo()
throws SQLException
{
if (serverInfo.get() == null) {
try {
serverInfo.set(queryExecutor.getServerInfo(httpUri));
}
catch (RuntimeException e) {
throw new SQLException("Error fetching version from server", e);
}
}
return serverInfo.get();
}
@VisibleForTesting
List<QueryInterceptor> getQueryInterceptorInstances()
{
return queryInterceptorInstances;
}
boolean shouldStartTransaction()
{
return !autoCommit.get() && (transactionId.get() == null);
}
String getStartTransactionSql()
throws SQLException
{
return format(
"START TRANSACTION ISOLATION LEVEL %s, READ %s",
getIsolationLevel(isolationLevel.get()),
readOnly.get() ? "ONLY" : "WRITE");
}
StatementClient startQuery(String sql, Map<String, String> sessionPropertiesOverride)
{
String source = "presto-jdbc";
String applicationName = clientInfo.get("ApplicationName");
if (applicationNamePrefix.isPresent()) {
source = applicationNamePrefix.get();
if (applicationName != null) {
source += applicationName;
}
}
else if (applicationName != null) {
source = applicationName;
}
Optional<String> traceToken = Optional.ofNullable(clientInfo.get("TraceToken"));
Iterable<String> clientTags = Splitter.on(',').trimResults().omitEmptyStrings()
.split(nullToEmpty(clientInfo.get("ClientTags")));
Map<String, String> allProperties = new HashMap<>(sessionProperties);
allProperties.putAll(sessionPropertiesOverride);
// zero means no timeout, so use a huge value that is effectively unlimited
int millis = networkTimeoutMillis.get();
Duration timeout = (millis > 0) ? new Duration(millis, MILLISECONDS) : new Duration(999, DAYS);
ClientSession session = new ClientSession(
httpUri,
user,
source,
traceToken,
ImmutableSet.copyOf(clientTags),
clientInfo.get("ClientInfo"),
catalog.get(),
schema.get(),
timeZoneId.get(),
locale.get(),
ImmutableMap.of(),
ImmutableMap.copyOf(allProperties),
ImmutableMap.copyOf(preparedStatements),
ImmutableMap.copyOf(roles),
extraCredentials,
transactionId.get(),
timeout,
compressionDisabled,
ImmutableMap.of(),
customHeaders,
validateNextUriSource);
return queryExecutor.startQuery(session, sql);
}
void updateSession(StatementClient client)
{
sessionProperties.putAll(client.getSetSessionProperties());
client.getResetSessionProperties().forEach(sessionProperties::remove);
preparedStatements.putAll(client.getAddedPreparedStatements());
client.getDeallocatedPreparedStatements().forEach(preparedStatements::remove);
client.getSetCatalog().ifPresent(catalog::set);
client.getSetSchema().ifPresent(schema::set);
if (client.getStartedTransactionId() != null) {
transactionId.set(client.getStartedTransactionId());
}
if (client.isClearTransactionId()) {
transactionId.set(null);
}
}
WarningsManager getWarningsManager()
{
return warningsManager;
}
Optional<PrestoResultSet> invokeQueryInterceptorsPre(String sql, Statement interceptedStatement)
{
Optional<PrestoResultSet> interceptedResultSet = Optional.empty();
for (QueryInterceptor interceptor : this.queryInterceptorInstances) {
Optional<PrestoResultSet> newResultSet = interceptor.preProcess(sql, interceptedStatement);
if (newResultSet.isPresent()) {
interceptedResultSet = newResultSet;
}
}
return interceptedResultSet;
}
PrestoResultSet invokeQueryInterceptorsPost(String sql, Statement interceptedStatement, PrestoResultSet originalResultSet)
{
PrestoResultSet interceptedResultSet = originalResultSet;
for (QueryInterceptor interceptor : this.queryInterceptorInstances) {
Optional<PrestoResultSet> newResultSet = interceptor.postProcess(sql, interceptedStatement, interceptedResultSet);
if (newResultSet.isPresent()) {
interceptedResultSet = newResultSet.get();
}
}
return interceptedResultSet;
}
private void checkOpen()
throws SQLException
{
if (isClosed()) {
throw new SQLException("Connection is closed");
}
}
private void initializeQueryInterceptors()
{
for (QueryInterceptor interceptor : this.queryInterceptorInstances) {
interceptor.init(this.sessionProperties);
}
}
private static void checkResultSet(int resultSetType, int resultSetConcurrency)
throws SQLFeatureNotSupportedException
{
if (resultSetType != ResultSet.TYPE_FORWARD_ONLY) {
throw new SQLFeatureNotSupportedException("Result set type must be TYPE_FORWARD_ONLY");
}
if (resultSetConcurrency != ResultSet.CONCUR_READ_ONLY) {
throw new SQLFeatureNotSupportedException("Result set concurrency must be CONCUR_READ_ONLY");
}
}
private static void checkHoldability(int resultSetHoldability)
throws SQLFeatureNotSupportedException
{
if (resultSetHoldability != ResultSet.HOLD_CURSORS_OVER_COMMIT) {
throw new SQLFeatureNotSupportedException("Result set holdability must be HOLD_CURSORS_OVER_COMMIT");
}
}
private static String getIsolationLevel(int level)
throws SQLException
{
switch (level) {
case TRANSACTION_READ_UNCOMMITTED:
return "READ UNCOMMITTED";
case TRANSACTION_READ_COMMITTED:
return "READ COMMITTED";
case TRANSACTION_REPEATABLE_READ:
return "REPEATABLE READ";
case TRANSACTION_SERIALIZABLE:
return "SERIALIZABLE";
}
throw new SQLException("Invalid transaction isolation level: " + level);
}
}