com.ing.data.cassandra.jdbc

Class CassandraConnection

java.lang.Object

com.ing.data.cassandra.jdbc.CassandraConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper

public class CassandraConnection
extends Object
implements Connection

Cassandra connection: implementation class for Connection to create a JDBC connection to a Cassandra cluster.

Field Summary

Fields

Modifier and Type	Field and Description
static int	dbMajorVersion Minimal Apache Cassandra major version supported by the Java Driver for Apache Cassandra®.
static int	dbMinorVersion Minimal Apache Cassandra minor version supported by the Java Driver for Apache Cassandra®.
static int	dbPatchVersion Minimal Apache Cassandra patch version supported by the Java Driver for Apache Cassandra®.
protected static int	FALLBACK_FETCH_SIZE The default fetch size when it's not configured neither in JDBC URL nor in a configuration file and the default fetch size (request page size) cannot be retrieved from the configuration profile.
protected String	url The connection URL.
protected String	username The username used by the connection.

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors

Constructor and Description
CassandraConnection(com.datastax.oss.driver.api.core.session.Session cSession, String currentKeyspace, com.datastax.oss.driver.api.core.ConsistencyLevel defaultConsistencyLevel, boolean debugMode, OptionSet optionSet, String defaultExecutionProfile) Instantiates a new JDBC connection to a Cassandra cluster using preexisting session.

Method Summary

Modifier and Type	Method and Description
void	abort(Executor executor)
void	clearWarnings()
void	close()
void	commit()
Array	createArrayOf(String typeName, Object[] elements)
Blob	createBlob()
Clob	createClob()
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)
com.datastax.oss.driver.api.core.config.DriverExecutionProfile	getActiveExecutionProfile() Gets the active execution profile.
boolean	getAutoCommit()
String	getCatalog()
Properties	getClientInfo()
String	getClientInfo(String label)
com.datastax.oss.driver.api.core.metadata.Metadata	getClusterMetadata() Gets the metadata of the Cassandra cluster used by this connection.
Properties	getConnectionProperties() Gets a Properties object listing the properties of this connection.
com.datastax.oss.driver.api.core.ConsistencyLevel	getConsistencyLevel() Gets the consistency level currently applied to this connection.
int	getDefaultFetchSize() Gets the default fetch size applied to this connection.
int	getHoldability()
DatabaseMetaData	getMetaData()
int	getNetworkTimeout()
OptionSet	getOptionSet() Gets the compliance mode option set used for the connection.
String	getSchema()
com.datastax.oss.driver.api.core.session.Session	getSession() Gets the CQL session used to send requests to the Cassandra cluster.
int	getTransactionIsolation()
Map<String,Class<?>>	getTypeMap()
SQLWarning	getWarnings()
boolean	isClosed()
boolean	isDebugMode() Gets whether the debug mode is active on this connection.
boolean	isReadOnly()
boolean	isValid(int timeout)
boolean	isWrapperFor(Class<?> iface)
String	nativeSQL(String sql)
CallableStatement	prepareCall(String cql)
CallableStatement	prepareCall(String cql, int resultSetType, int resultSetConcurrency)
CallableStatement	prepareCall(String cql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
CassandraPreparedStatement	prepareStatement(String cql)
PreparedStatement	prepareStatement(String cql, int autoGeneratedKeys)
PreparedStatement	prepareStatement(String cql, int[] columnIndexes)
CassandraPreparedStatement	prepareStatement(String cql, int resultSetType, int resultSetConcurrency)
CassandraPreparedStatement	prepareStatement(String cql, int resultSetType, int resultSetConcurrency, int resultSetHoldability)
PreparedStatement	prepareStatement(String cql, String[] columnNames)
void	releaseSavepoint(Savepoint savepoint)
protected boolean	removeStatement(Statement statement) Removes a statement from the open statements list.
void	restoreLastExecutionProfile() Restores the last execution profile defined before switching it.
void	rollback()
void	rollback(Savepoint savepoint)
void	setActiveExecutionProfile(String profile) Sets a new execution profile for the current connection.
void	setAutoCommit(boolean autoCommit)
void	setCatalog(String catalog)
void	setClientInfo(Properties properties)
void	setClientInfo(String key, String value)
void	setConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel) Sets the consistency level applied to this connection.
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)
String	toString()
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.Connection

abort, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStruct, getNetworkTimeout, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, setNetworkTimeout, setSavepoint, setSavepoint, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

dbMajorVersion

public static volatile int dbMajorVersion

Minimal Apache Cassandra major version supported by the Java Driver for Apache Cassandra®.

dbMinorVersion

public static volatile int dbMinorVersion

Minimal Apache Cassandra minor version supported by the Java Driver for Apache Cassandra®.

dbPatchVersion

public static volatile int dbPatchVersion

Minimal Apache Cassandra patch version supported by the Java Driver for Apache Cassandra®.

FALLBACK_FETCH_SIZE

protected static final int FALLBACK_FETCH_SIZE

The default fetch size when it's not configured neither in JDBC URL nor in a configuration file and the default fetch size (request page size) cannot be retrieved from the configuration profile.

See Also:

Constant Field Values

username

protected String username

The username used by the connection.

url

protected String url

The connection URL.

Constructor Detail

CassandraConnection

public CassandraConnection(com.datastax.oss.driver.api.core.session.Session cSession,
                           String currentKeyspace,
                           com.datastax.oss.driver.api.core.ConsistencyLevel defaultConsistencyLevel,
                           boolean debugMode,
                           OptionSet optionSet,
                           String defaultExecutionProfile)

Instantiates a new JDBC connection to a Cassandra cluster using preexisting session.

Parameters:

cSession - The session to use.

currentKeyspace - The keyspace to use.

defaultConsistencyLevel - The default consistency level.

debugMode - Debug mode flag.

optionSet - The compliance mode option set to use.

defaultExecutionProfile - The name of the default execution profile to use.

Method Detail

clearWarnings

public void clearWarnings()
                   throws SQLException

Specified by:

clearWarnings in interface Connection

Throws:

SQLException

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Connection

Throws:

SQLException

commit

public void commit()
            throws SQLException

Specified by:

commit in interface Connection

Throws:

SQLException

createStatement

public Statement createStatement()
                          throws SQLException

Specified by:

createStatement in interface Connection

Throws:

SQLException

createStatement

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

Specified by:

createStatement 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

getAutoCommit

public boolean getAutoCommit()
                      throws SQLException

Specified by:

getAutoCommit in interface Connection

Throws:

SQLException

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws SQLException

Specified by:

setAutoCommit in interface Connection

Throws:

SQLException

getCatalog

public String getCatalog()
                  throws SQLException

Specified by:

getCatalog in interface Connection

Throws:

SQLException

setCatalog

public void setCatalog(String catalog)
                throws SQLException

Specified by:

setCatalog in interface Connection

Throws:

SQLException

getConnectionProperties

public Properties getConnectionProperties()

Gets a Properties object listing the properties of this connection.

Returns:

The properties of this connection.

getClientInfo

public Properties getClientInfo()
                         throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

getClientInfo

public String getClientInfo(String label)
                     throws SQLException

Specified by:

getClientInfo in interface Connection

Throws:

SQLException

setClientInfo

public void setClientInfo(Properties properties)

Specified by:

setClientInfo in interface Connection

setClientInfo

public void setClientInfo(String key,
                          String value)

Specified by:

setClientInfo in interface Connection

getClusterMetadata

public com.datastax.oss.driver.api.core.metadata.Metadata getClusterMetadata()

Gets the metadata of the Cassandra cluster used by this connection.

Returns:

The metadata of the Cassandra cluster used by this connection.

isDebugMode

public boolean isDebugMode()

Gets whether the debug mode is active on this connection.

Returns:

true if the debug mode is active on this connection, false otherwise.

getConsistencyLevel

public com.datastax.oss.driver.api.core.ConsistencyLevel getConsistencyLevel()

Gets the consistency level currently applied to this connection.

Returns:

The consistency level currently applied to this connection.

setConsistencyLevel

public void setConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)

Sets the consistency level applied to this connection.

Parameters:

consistencyLevel - The consistency level to apply to this connection.

getDefaultFetchSize

public int getDefaultFetchSize()

Gets the default fetch size applied to this connection.

Returns:

The default fetch size applied to this connection.

getHoldability

public int getHoldability()
                   throws SQLException

Specified by:

getHoldability in interface Connection

Throws:

SQLException

setHoldability

public void setHoldability(int holdability)
                    throws SQLException

Specified by:

setHoldability in interface Connection

Throws:

SQLException

getMetaData

public DatabaseMetaData getMetaData()
                             throws SQLException

Specified by:

getMetaData 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)
               throws SQLException

Specified by:

setSchema in interface Connection

Throws:

SQLException

getSession

public com.datastax.oss.driver.api.core.session.Session getSession()

Gets the CQL session used to send requests to the Cassandra cluster.

Returns:

The CQL session.

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

getTypeMap

public Map<String,Class<?>> getTypeMap()
                                throws SQLException

Specified by:

getTypeMap in interface Connection

Throws:

SQLException

getWarnings

public SQLWarning getWarnings()
                       throws SQLException

Specified by:

getWarnings in interface Connection

Throws:

SQLException

isClosed

public boolean isClosed()
                 throws SQLException

Specified by:

isClosed in interface Connection

Throws:

SQLException

isReadOnly

public boolean isReadOnly()
                   throws SQLException

Specified by:

isReadOnly in interface Connection

Throws:

SQLException

setReadOnly

public void setReadOnly(boolean readOnly)
                 throws SQLException

Specified by:

setReadOnly in interface Connection

Throws:

SQLException

isValid

public boolean isValid(int timeout)
                throws SQLTimeoutException

Specified by:

isValid in interface Connection

Throws:

SQLTimeoutException

nativeSQL

public String nativeSQL(String sql)
                 throws SQLException

Specified by:

nativeSQL in interface Connection

Throws:

SQLException

prepareStatement

public CassandraPreparedStatement prepareStatement(String cql)
                                            throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public CassandraPreparedStatement prepareStatement(String cql,
                                                   int resultSetType,
                                                   int resultSetConcurrency)
                                            throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

prepareStatement

public CassandraPreparedStatement prepareStatement(String cql,
                                                   int resultSetType,
                                                   int resultSetConcurrency,
                                                   int resultSetHoldability)
                                            throws SQLException

Specified by:

prepareStatement in interface Connection

Throws:

SQLException

rollback

public void rollback()
              throws SQLException

Specified by:

rollback in interface Connection

Throws:

SQLException

removeStatement

protected boolean removeStatement(Statement statement)

Removes a statement from the open statements list.

Parameters:

statement - The statement.

Returns:

true if the statement has successfully been removed, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

getOptionSet

public OptionSet getOptionSet()

Gets the compliance mode option set used for the connection.

Returns:

The compliance mode option set used for the connection.

getActiveExecutionProfile

public com.datastax.oss.driver.api.core.config.DriverExecutionProfile getActiveExecutionProfile()

Gets the active execution profile.

Returns:

The active execution profile.

setActiveExecutionProfile

public void setActiveExecutionProfile(String profile)

Sets a new execution profile for the current connection.

If the given profile name is invalid, this method has no effect.

Parameters:

profile - The execution profile to set.

restoreLastExecutionProfile

public void restoreLastExecutionProfile()

Restores the last execution profile defined before switching it.

If the execution profile has never been changed previously, this method has no effect.

createArrayOf

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

Throws:

SQLException

createBlob

public Blob createBlob()
                throws SQLException

Throws:

SQLException

createClob

public Clob createClob()
                throws SQLException

Throws:

SQLException

createNClob

public NClob createNClob()
                  throws SQLException

Throws:

SQLException

createSQLXML

public SQLXML createSQLXML()
                    throws SQLException

Throws:

SQLException

createStruct

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

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String cql)
                              throws SQLException

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String cql,
                                     int resultSetType,
                                     int resultSetConcurrency)
                              throws SQLException

Throws:

SQLException

prepareCall

public CallableStatement prepareCall(String cql,
                                     int resultSetType,
                                     int resultSetConcurrency,
                                     int resultSetHoldability)
                              throws SQLException

Throws:

SQLException

prepareStatement

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

Throws:

SQLException

prepareStatement

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

Throws:

SQLException

prepareStatement

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

Throws:

SQLException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws SQLException

Throws:

SQLException

rollback

public void rollback(Savepoint savepoint)
              throws SQLException

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint()
                       throws SQLException

Throws:

SQLException

setSavepoint

public Savepoint setSavepoint(String name)
                       throws SQLException

Throws:

SQLException

setTypeMap

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

Throws:

SQLException

abort

public void abort(Executor executor)
           throws SQLException

Throws:

SQLException

setNetworkTimeout

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

Throws:

SQLException

getNetworkTimeout

public int getNetworkTimeout()
                      throws SQLException

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException