Skip navigation links

com.timesten.jdbc
Interface TimesTenConnection

All Superinterfaces:

java.sql.Connection, java.sql.Wrapper

public interface TimesTenConnection

extends java.sql.Connection

Provides TimesTen extensions to java.sql.Connection

See Also:

Connection

Field Summary

static java.lang.String	CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE The value of this property is used as the default LOB prefetch size for this connection.
static java.lang.String	CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE_DEFAULT

Fields inherited from interface java.sql.Connection

TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Method Summary

void	addConnectionEventListener(ClientFailoverEventListener listener) Register Client Failover (ACF) event listener.
TimesTenBlob	createBLOB() Constructs an object that implements the TimesTenBlob interface.
TimesTenClob	createCLOB() Constructs an object that implements the TimesTenClob interface.
int	getReplicationTrack() Retrieves current track for parallel replication.
boolean	getTtPrefetchClose() Returns the current state of TT_PREFETCH_CLOSE
int	getTtPrefetchCount() Gets the value of TT_PREFETCH_COUNT
boolean	isDataStoreValid() Applications can use this light weight method to detect if the data store is valid or not (rather than execute "some SQL" or built-in procedure.
void	removeConnectionEventListener(ClientFailoverEventListener listener) Remove ACF event listener.
void	setReplicationTrack(int track) Sets replication track for parallel replication.
void	setTtPrefetchClose(boolean enable) Sets the state of TT_PREFETCH_CLOSE to true or false
void	setTtPrefetchCount(int count) Sets the TT_PREFETCH_COUNT value

Methods inherited from interface java.sql.Connection

clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setReadOnly, setSavepoint, setSavepoint, setTransactionIsolation, setTypeMap

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE

static final java.lang.String CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE

The value of this property is used as the default LOB prefetch size for this connection. The LOB prefetch size can be overriden at the statement level through the setLobPrefetchSize(int) which is defined in com.timesten.timesten.TimesTenStatement. The value can be "-1" to disable LOB prefetch for this connection, "0" to enable LOB prefetch for meta-data only or any value greater than 0 which represents a number of bytes for BLOBs and chars for CLOBs to be prefetched along with the locator during fetch operations. The default value for this property is "4000".

Since:

11.2.2

See Also:

Constant Field Values

CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE_DEFAULT

static final java.lang.String CONNECTION_PROPERTY_DEFAULT_LOB_PREFETCH_SIZE_DEFAULT

See Also:

Constant Field Values

Method Detail

setTtPrefetchClose

void setTtPrefetchClose(boolean enable)
                        throws java.sql.SQLException

Sets the state of TT_PREFETCH_CLOSE to true or false

Parameters:

enable - true to set TT_PREFETCH_CLOSE to true, false to set TT_PREFETCH_CLOSE to false.

Throws:

java.sql.SQLException - if a database access error occurs

getTtPrefetchClose

boolean getTtPrefetchClose()
                           throws java.sql.SQLException

Returns the current state of TT_PREFETCH_CLOSE

Returns:

true if TT_PREFETCH_CLOSE is true, or false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

setTtPrefetchCount

void setTtPrefetchCount(int count)
                        throws java.sql.SQLException

Sets the TT_PREFETCH_COUNT value

Parameters:

count - the value to set TT_PREFETCH_COUNT to

Throws:

java.sql.SQLException - if a database access error occurs

getTtPrefetchCount

int getTtPrefetchCount()
                       throws java.sql.SQLException

Gets the value of TT_PREFETCH_COUNT

Returns:

the TT_PREFETCH_COUNT value

Throws:

java.sql.SQLException - if a database access error occurs

isDataStoreValid

boolean isDataStoreValid()
                         throws java.sql.SQLException

Applications can use this light weight method to detect if the data store is valid or not (rather than execute "some SQL" or built-in procedure.

Returns:

true if the corresponding shared memory segment is NOT dirty. Else false.

Throws:

java.sql.SQLException - if a database access error occurs

addConnectionEventListener

void addConnectionEventListener(ClientFailoverEventListener listener)
                                throws java.sql.SQLException

Register Client Failover (ACF) event listener. These events are applicable to C/S connections only.

Parameters:

listener - ACF event listener

Throws:

java.sql.SQLException - if a database access error occurs

Since:

11.2.1

See Also:

ClientFailoverEventListener

removeConnectionEventListener

void removeConnectionEventListener(ClientFailoverEventListener listener)
                                   throws java.sql.SQLException

Remove ACF event listener. These events are applicable to C/S connections only.

Parameters:

listener - ACF event listener

Throws:

java.sql.SQLException - if a database access error occurs

Since:

11.2.1

See Also:

ClientFailoverEventListener

setReplicationTrack

void setReplicationTrack(int track)
                         throws java.sql.SQLException

Sets replication track for parallel replication.

Parameters:

track - Replication track for parallel replication.

Throws:

java.sql.SQLException - if a database access error occurs.

Since:

11.2.1.6.0

getReplicationTrack

int getReplicationTrack()
                        throws java.sql.SQLException

Retrieves current track for parallel replication.

Returns:

Current track.

Throws:

java.sql.SQLException - if a database error occurs.

Since:

11.2.1.6.0

createBLOB

TimesTenBlob createBLOB()
                        throws java.sql.SQLException

Constructs an object that implements the TimesTenBlob interface. This is a TimesTen extension for createBlob in JDBC 4. The object returned initially contains no data. The setBinaryStream and setBytes methods of the Blob interface may be used to add data to the Blob.

Returns:

An objects that implements TimesTenBlob interface

Throws:

java.sql.SQLException - if an object that implements the Blob interface can not be constructed, this method is called on a closed connection or a database access error occurs.

Since:

11.2.2

createCLOB

TimesTenClob createCLOB()
                        throws java.sql.SQLException

Constructs an object that implements the TimesTenClob interface. This is a TimesTen extension for createClob in JDBC 4. The object returned initially contains no data. The setAsciiStream, setCharacterStream and setString methods of the Clob interface may be used to add data to the Clob.

Returns:

An object that implements the TimesTenClob interface.

Throws:

java.sql.SQLException - if an object that implements the TimesTenClob interface can not be constructed, this method is called on a closed connection or a database access error occurs.

Since:

11.2.2

Skip navigation links