Package com.firebolt.jdbc.connection

Class FireboltConnection

java.lang.Object

com.firebolt.jdbc.JdbcBase

com.firebolt.jdbc.connection.FireboltConnection

All Implemented Interfaces:

CacheListener, GenericWrapper, AutoCloseable, Connection, Wrapper, EventListener

Direct Known Subclasses:

FireboltConnectionServiceSecret, FireboltConnectionUserPassword

public abstract class FireboltConnection
extends JdbcBase
implements Connection, CacheListener

Field Summary

Fields

Modifier and Type	Field	Description
protected String	httpConnectionUrl
protected final FireboltProperties	loginProperties
final ParserVersion	parserVersion
protected FireboltProperties	sessionProperties

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FireboltConnection(@NonNull String url, Properties connectionSettings, FireboltAuthenticationService fireboltAuthenticationService, FireboltStatementService fireboltStatementService, String protocolVersion, ParserVersion parserVersion)
protected	FireboltConnection(@NonNull String url, Properties connectionSettings, String protocolVersion, ParserVersion parserVersion)

Method Summary

Modifier and Type	Method	Description
void	abort(Executor executor)
void	addProperty(@NonNull String key, String value)	By default, when adding a property it is validating the connection
void	addProperty(@NonNull String key, String value, boolean validateConnection)
void	addProperty(Map.Entry<String,String> property)
void	addProperty(Map.Entry<String,String> property, boolean validateConnection)
protected abstract void	authenticate()
boolean	cancelAsyncQuery(String asyncQueryToken)
void	cleanup()
void	close()
void	commit()
protected void	connect()
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
protected abstract FireboltAuthenticationClient	createFireboltAuthenticationClient(okhttp3.OkHttpClient httpClient)
NClob	createNClob()
SQLXML	createSQLXML()
Statement	createStatement()
Statement	createStatement(int resultSetType, int resultSetConcurrency)
Statement	createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability)
Struct	createStruct(String typeName, Object[] attributes)
protected FireboltProperties	extractFireboltProperties(String jdbcUri, Properties connectionProperties)
Optional<String>	getAccessToken()
protected Optional<String>	getAccessToken(FireboltProperties fireboltProperties)
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String name)
int	getConnectionTimeout()
abstract Optional<String>	getConnectionUserAgentHeader()	A connection should implement this method if it needs to set additional details on the user agent header for the calls sent to Firebolt backend
String	getEndpoint()
String	getEngine()
int	getHoldability()
protected okhttp3.OkHttpClient	getHttpClient(FireboltProperties fireboltProperties)
abstract int	getInfraVersion()	Returns the version of the firebolt backend the connection is established to
DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
String	getProtocolVersion()
String	getSchema()
FireboltProperties	getSessionProperties()
int	getTransactionIsolation()
Map<String,Class<?>>	getTypeMap()
boolean	isAsyncQueryRunning(String asyncQueryToken)
boolean	isAsyncQuerySuccessful(String asyncQueryToken)
boolean	isClosed()
protected abstract boolean	isConnectionCachingEnabled()	If the connection information can be cached for subsequent reuse, then the specific connection should provide implementation
boolean	isReadOnly()
boolean	isValid(int timeout)
String	nativeSQL(String sql)
CallableStatement	prepareCall(String sql)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency)
CallableStatement	prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql)
PreparedStatement	prepareStatement(String sql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String sql, int[] columnIndexes)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency)
PreparedStatement	prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String sql, String[] columnNames)
void	register(CacheListener listener)
void	releaseSavepoint(Savepoint savepoint)
void	removeClosedStatement(FireboltStatement fireboltStatement)
void	removeExpiredTokens()
void	reset()	Server side lets us know when the connection needs to be reset.
void	rollback()
void	rollback(Savepoint savepoint)
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(String name, String value)
void	setClientInfo(Properties properties)
void	setEndpoint(String endpoint)
void	setHoldability(int holdability)
void	setNetworkTimeout(Executor executor, int milliseconds)
void	setReadOnly(boolean readOnly)
Savepoint	setSavepoint()
Savepoint	setSavepoint(String name)
void	setSchema(String schema)
void	setTransactionIsolation(int level)
void	setTypeMap(Map<String,Class<?>> map)
protected abstract void	validateConnectionParameters()	Validates that the required parameters are present for the connection

Methods inherited from class com.firebolt.jdbc.JdbcBase

addWarning, clearWarnings, getWarnings

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

beginRequest, clearWarnings, endRequest, getWarnings, setShardingKey, setShardingKey, setShardingKeyIfValid, setShardingKeyIfValid

Methods inherited from interface com.firebolt.jdbc.GenericWrapper

isWrapperFor, unwrap

Field Details

httpConnectionUrl

protected String httpConnectionUrl

sessionProperties

protected FireboltProperties sessionProperties

loginProperties

protected final FireboltProperties loginProperties

parserVersion

public final ParserVersion parserVersion

Constructor Details

FireboltConnection

protected FireboltConnection(@NonNull
 @NonNull String url,
 Properties connectionSettings,
 FireboltAuthenticationService fireboltAuthenticationService,
 FireboltStatementService fireboltStatementService,
 String protocolVersion,
 ParserVersion parserVersion)

FireboltConnection

protected FireboltConnection(@NonNull
 @NonNull String url,
 Properties connectionSettings,
 String protocolVersion,
 ParserVersion parserVersion)
                      throws SQLException

Throws:

SQLException

Method Details

createFireboltAuthenticationClient

protected abstract FireboltAuthenticationClient createFireboltAuthenticationClient(okhttp3.OkHttpClient httpClient)

getHttpClient

protected okhttp3.OkHttpClient getHttpClient(FireboltProperties fireboltProperties)
                                      throws SQLException

Throws:

SQLException

connect

protected void connect()
                throws SQLException

Throws:

SQLException

getInfraVersion

public abstract int getInfraVersion()

Returns the version of the firebolt backend the connection is established to

authenticate

protected abstract void authenticate()
                              throws SQLException

Throws:

SQLException

validateConnectionParameters

protected abstract void validateConnectionParameters()
                                              throws SQLException

Validates that the required parameters are present for the connection

Throws:

SQLException

isConnectionCachingEnabled

protected abstract boolean isConnectionCachingEnabled()

If the connection information can be cached for subsequent reuse, then the specific connection should provide implementation

Returns:

- true if the connection supports caching. False otherwise

getConnectionUserAgentHeader

public abstract Optional<String> getConnectionUserAgentHeader()

A connection should implement this method if it needs to set additional details on the user agent header for the calls sent to Firebolt backend

Returns:

removeExpiredTokens

public void removeExpiredTokens()
                         throws SQLException

Throws:

SQLException

getAccessToken

public Optional<String> getAccessToken()
                                throws SQLException

Throws:

SQLException

getAccessToken

protected Optional<String> getAccessToken(FireboltProperties fireboltProperties)
                                   throws SQLException

Throws:

SQLException

getSessionProperties

public FireboltProperties getSessionProperties()

createStatement

public Statement createStatement()
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

setAutoCommit

@NotImplemented
public void setAutoCommit(boolean autoCommit)

Specified by:

setAutoCommit in interface Connection

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Connection

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Specified by:

getMetaData in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

setCatalog

@NotImplemented
public void setCatalog(String catalog)

Specified by:

setCatalog in interface Connection

getEngine

public String getEngine()

getTransactionIsolation

public int getTransactionIsolation()
                            throws SQLException

Specified by:

getTransactionIsolation in interface Connection

Throws:

SQLException

setTransactionIsolation

public void setTransactionIsolation(int level)
                             throws SQLException

Specified by:

setTransactionIsolation in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

getSchema

public String getSchema()
                 throws SQLException

Specified by:

getSchema in interface Connection

Throws:

SQLException

setSchema

public void setSchema(String schema)

Specified by:

setSchema in interface Connection

abort

public void abort(Executor executor)
           throws SQLException

Specified by:

abort in interface Connection

Throws:

SQLException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

extractFireboltProperties

protected FireboltProperties extractFireboltProperties(String jdbcUri,
 Properties connectionProperties)

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public PreparedStatement prepareStatement(String sql)
                                   throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String sql)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

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

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement(int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

isValid

public boolean isValid(int timeout)
                throws SQLException

Specified by:

isValid in interface Connection

Throws:

SQLException

removeClosedStatement

public void removeClosedStatement(FireboltStatement fireboltStatement)

addProperty

public void addProperty(@NonNull
 @NonNull String key,
 String value)
                 throws SQLException

By default, when adding a property it is validating the connection

Throws:

SQLException

addProperty

public void addProperty(@NonNull
 @NonNull String key,
 String value,
 boolean validateConnection)
                 throws SQLException

Throws:

SQLException

addProperty

public void addProperty(Map.Entry<String,String> property)
                 throws SQLException

Throws:

SQLException

addProperty

public void addProperty(Map.Entry<String,String> property,
 boolean validateConnection)
                 throws SQLException

Throws:

SQLException

reset

public void reset()
           throws SQLException

Server side lets us know when the connection needs to be reset. so no need to validate the connection.

Throws:

SQLException

setEndpoint

public void setEndpoint(String endpoint)

getEndpoint

public String getEndpoint()

commit

@NotImplemented
public void commit()

Specified by:

commit in interface Connection

rollback

@NotImplemented
public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

setNetworkTimeout

public void setNetworkTimeout(Executor executor,
 int milliseconds)
                       throws SQLException

Specified by:

setNetworkTimeout in interface Connection

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()

Specified by:

getNetworkTimeout in interface Connection

getConnectionTimeout

public int getConnectionTimeout()

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

setReadOnly

@NotImplemented
public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface Connection

prepareCall

@NotImplemented
public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

getTypeMap

@NotImplemented
public Map<String,Class<?>> getTypeMap()

Specified by:

getTypeMap in interface Connection

setTypeMap

@NotImplemented
public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException

Specified by:

setTypeMap in interface Connection

Throws:

SQLException

getHoldability

public int getHoldability()
                   throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setHoldability

@NotImplemented
public void setHoldability(int holdability)

Specified by:

setHoldability in interface Connection

setSavepoint

@NotImplemented
public Savepoint setSavepoint()
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

setSavepoint

@NotImplemented
public Savepoint setSavepoint(String name)
                       throws SQLException

Specified by:

setSavepoint in interface Connection

Throws:

SQLException

rollback

@NotImplemented
public void rollback(Savepoint savepoint)
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

releaseSavepoint

@NotImplemented
public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Specified by:

releaseSavepoint in interface Connection

Throws:

SQLException

prepareCall

@NotImplemented
public CallableStatement prepareCall(String sql,
 int resultSetType,
 int resultSetConcurrency,
 int resultSetHoldability)
                              throws SQLException

Specified by:

prepareCall in interface Connection

Throws:

SQLException

createClob

public Clob createClob()

Specified by:

createClob in interface Connection

createBlob

public Blob createBlob()

Specified by:

createBlob in interface Connection

createNClob

public NClob createNClob()

Specified by:

createNClob in interface Connection

createSQLXML

@NotImplemented
public SQLXML createSQLXML()
                    throws SQLException

Specified by:

createSQLXML in interface Connection

Throws:

SQLException

setClientInfo

@NotImplemented
public void setClientInfo(String name,
 String value)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

getClientInfo

public String getClientInfo(String name)

Specified by:

getClientInfo in interface Connection

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

setClientInfo

@NotImplemented
public void setClientInfo(Properties properties)
                   throws SQLClientInfoException

Specified by:

setClientInfo in interface Connection

Throws:

SQLClientInfoException

createArrayOf

public Array createArrayOf(String typeName,
 Object[] elements)
                    throws SQLException

Specified by:

createArrayOf in interface Connection

Throws:

SQLException

createStruct

@NotImplemented
public Struct createStruct(String typeName,
 Object[] attributes)
                    throws SQLException

Specified by:

createStruct in interface Connection

Throws:

SQLException

getProtocolVersion

public String getProtocolVersion()

register

public void register(CacheListener listener)

cleanup

public void cleanup()

Specified by:

cleanup in interface CacheListener

isAsyncQueryRunning

public boolean isAsyncQueryRunning(String asyncQueryToken)
                            throws SQLException

Throws:

SQLException

isAsyncQuerySuccessful

public boolean isAsyncQuerySuccessful(String asyncQueryToken)
                               throws SQLException

Throws:

SQLException

cancelAsyncQuery

public boolean cancelAsyncQuery(String asyncQueryToken)
                         throws SQLException

Throws:

SQLException