com.aspc.remote.database

Class CSQL

java.lang.Object

com.aspc.remote.database.internal.SResultSet

com.aspc.remote.database.CSQL

All Implemented Interfaces:

ResultsLoader, java.lang.AutoCloseable, java.sql.ResultSet, java.sql.Wrapper

public final class CSQL
extends SResultSet
implements ResultsLoader

CSQL is a wrapper for JDBC. It simplifies the usage/error handling of JDBC
THREAD MODE: SINGLE-THREADED sql

Since:

August 19, 1996

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEBUG_SHOW_STACK show the stack trace
static int	DEFAULT_QUERY_TIMEOUT_SECONDS the default number of seconds before timing out
static org.apache.commons.logging.Log	LOGGER_TIMINGS_SQL the SQL logger
static java.lang.String	PROPERTY_DEFAULT_QUERY_TIMEOUT_SECONDS control the default query timeout
static java.lang.String	PROPERTY_LOG_SLOW_STACK_TRACE_TIME control the time we will log the stack traces of slow requests

Fields inherited from class com.aspc.remote.database.internal.SResultSet

ALLOW_OVERFLOW, columnKeys, columns, currentData, rowOffset, rowPage

Fields inherited from interface java.sql.ResultSet

CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE

Constructor Summary

Constructors

Constructor and Description
CSQL(DataBase db)

Method Summary

Modifier and Type	Method and Description
CSQL	addBatch(java.lang.String theSql) Batch batchStatement
CSQL	addPreparedStatement(java.lang.String statement, java.lang.Object... args) add prepared statement
static void	addThreadID(java.lang.String threadID) add additional thread IDs
void	beginTransaction() Starts a transaction.
protected void	clear()
static void	clearThreadIDs() clear the Thread IDs.
void	commit() Ends a transaction.
CSQL	disableErrorLogging() Disable error level logging ( warning only).
CSQL	enableErrorLogging() Enable error level logging
java.lang.String	encodeTableData(boolean header_fg) Produces a tab separated data string.
java.lang.String	encodeTableData(boolean header_fg, int whichRow, java.util.List restrictCols) With addition option of a row ( -1 for all rows) and only some columns
void	execute(java.lang.String inSql)
int[]	executeBatch() Execute batch batchStatement
CSQL	findOne(java.lang.String theSelect)
int	getColumnType(int c) Returns the name of the column at index.
DataBase	getDataBase()
java.sql.SQLWarning	getFirstWarning(java.sql.Statement stmt)
static long	getHitCount() The hit count
static long	getHitRowCount() The hit ROW count
static long	getLargeHitCount() The hit count
int	getRowCount()
java.lang.String	getSQL()
java.lang.String	getSQLTypeDesc()
java.lang.String	getWarningText()
boolean	hasColumn(java.lang.String key)
boolean	hasMoreResults()
boolean	hasOutput() Returns true if the batchStatement was a select type of batchStatement
boolean	hasWarnings()
static long	incrementHitCount() Increment hit count
static long	incrementLargeHitCount() Increment hit count
boolean	isStateless() are we stateless ?
int	loadResults(java.sql.Statement stmt)
void	lockConnection() Lock the database connection
CSQL	nextResults()
CSQL	perform(java.lang.String inSql) performs the SQL batchStatement passed.
static void	recordTime(java.lang.Object inObj, Lap lap, java.sql.Connection conn, java.lang.Throwable e, int rows, DataBase dataBase) Record the SQL time
static java.util.concurrent.atomic.AtomicLong	registerThreadHitsCounter(java.util.concurrent.atomic.AtomicLong counter) register the hits counter for this thread
static java.util.concurrent.atomic.AtomicLong	registerThreadLargeHitsCounter(java.util.concurrent.atomic.AtomicLong counter) register the hits counter for this thread
static java.util.concurrent.atomic.AtomicLong	registerThreadTimeOnDB(java.util.concurrent.atomic.AtomicLong timeOnDB) register the time on the database for this thread
void	rollback() Rolls back the current transaction.
CSQL	setLoader(ResultsLoader loader)
CSQL	setMaxRow(int maxRow)
CSQL	setQueryTimeOutSeconds(int seconds) Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds.
CSQL	setReadOnly(boolean readonly) Force the statement to be read only
static long	simulateSlowQuery(long delayMS) Slow ALL queries from this thread down by the delay milliseconds.
void	unlockConnection() Unlock the database connection.

Methods inherited from class com.aspc.remote.database.internal.SResultSet

absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, decodeTableData, deleteRow, fetchRow, findColumn, findColumnData, findColumnData, first, formatOutput, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getColumnCount, getColumnDisplaySize, getColumnName, getColumns, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getMetaData, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, isNull, isNull, isWrapperFor, last, load, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rewind, rowDeleted, rowInserted, rowUpdated, setCurrentRow, setFetchDirection, setFetchSize, sqlColumnNr, toString, unwrap, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, validToGet, wasNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.sql.ResultSet

updateObject, updateObject, updateObject, updateObject

Field Detail

LOGGER_TIMINGS_SQL

public static final org.apache.commons.logging.Log LOGGER_TIMINGS_SQL

the SQL logger

DEBUG_SHOW_STACK

public static final java.lang.String DEBUG_SHOW_STACK

show the stack trace

See Also:

Constant Field Values

PROPERTY_LOG_SLOW_STACK_TRACE_TIME

public static final java.lang.String PROPERTY_LOG_SLOW_STACK_TRACE_TIME

control the time we will log the stack traces of slow requests

See Also:

Constant Field Values

PROPERTY_DEFAULT_QUERY_TIMEOUT_SECONDS

public static final java.lang.String PROPERTY_DEFAULT_QUERY_TIMEOUT_SECONDS

control the default query timeout

See Also:

Constant Field Values

DEFAULT_QUERY_TIMEOUT_SECONDS

public static final int DEFAULT_QUERY_TIMEOUT_SECONDS

the default number of seconds before timing out

Constructor Detail

CSQL

public CSQL(@Nonnull
            DataBase db)

Parameters:

db - the database

Method Detail

simulateSlowQuery

public static long simulateSlowQuery(@Nonnegative
                                     long delayMS)

Slow ALL queries from this thread down by the delay milliseconds.

Parameters:

delayMS - 0 or less means no delay.

Returns:

the previous delay value.

disableErrorLogging

@Nonnull
public CSQL disableErrorLogging()

Disable error level logging ( warning only).

Returns:

this

enableErrorLogging

@Nonnull
public CSQL enableErrorLogging()

Enable error level logging

Returns:

this

setReadOnly

@Nonnull
public CSQL setReadOnly(boolean readonly)

Force the statement to be read only

Parameters:

readonly - true if this query should be readonly.

Returns:

this.

addThreadID

public static void addThreadID(@Nonnull
                               java.lang.String threadID)

add additional thread IDs

Parameters:

threadID - the thread id

clearThreadIDs

public static void clearThreadIDs()

clear the Thread IDs.

registerThreadHitsCounter

@Nonnull
public static java.util.concurrent.atomic.AtomicLong registerThreadHitsCounter(@Nonnull
                                                                                        java.util.concurrent.atomic.AtomicLong counter)

register the hits counter for this thread

Parameters:

counter - the hits counter

Returns:

the old counter

registerThreadLargeHitsCounter

@Nonnull
public static java.util.concurrent.atomic.AtomicLong registerThreadLargeHitsCounter(@Nonnull
                                                                                             java.util.concurrent.atomic.AtomicLong counter)

register the hits counter for this thread

Parameters:

counter - the hits counter

Returns:

the old counter

registerThreadTimeOnDB

@Nonnull
public static java.util.concurrent.atomic.AtomicLong registerThreadTimeOnDB(@Nonnull
                                                                                     java.util.concurrent.atomic.AtomicLong timeOnDB)

register the time on the database for this thread

Parameters:

timeOnDB - the time on the database

Returns:

the old time on the database holder

setLoader

@Nonnull
public CSQL setLoader(@Nonnull
                               ResultsLoader loader)

Parameters:

loader - the loader

Returns:

this

lockConnection

public void lockConnection()
                    throws java.sql.SQLException

Lock the database connection

Throws:

java.sql.SQLException - a serious problem

unlockConnection

public void unlockConnection()

Unlock the database connection.

getDataBase

@CheckReturnValue
 @Nonnull
public DataBase getDataBase()

Returns:

the database

isStateless

@CheckReturnValue
public boolean isStateless()
                                      throws java.lang.Exception

are we stateless ?

Returns:

TRUE if we are stateless

Throws:

java.lang.Exception - a database error occurred

beginTransaction

public void beginTransaction()
                      throws java.sql.SQLException

Starts a transaction. This wrapper is needed due to multiple threads/connections. Thread Safe: we synchronize on a static table so that we don't "lose" any connections.

Throws:

java.sql.SQLException - a serious problem

commit

public void commit()
            throws java.sql.SQLException

Ends a transaction. This wrapper is needed due to multiple threads/connections

Throws:

java.sql.SQLException - a serious problem

rollback

public void rollback()

Rolls back the current transaction. This wrapper is needed due to multiple threads/connections

getRowCount

@CheckReturnValue
 @Nonnegative
public int getRowCount()

Returns:

the row count

getSQLTypeDesc

@CheckReturnValue
 @Nonnull
public java.lang.String getSQLTypeDesc()

Returns:

the description

getColumnType

@CheckReturnValue
public int getColumnType(@Nonnegative
                                           int c)

Description copied from class: SResultSet

Returns the name of the column at index.

Overrides:

getColumnType in class SResultSet

Parameters:

c - the column

Returns:

the type

hasColumn

@CheckReturnValue
public boolean hasColumn(@Nonnull
                                           java.lang.String key)

Parameters:

key - the column

Returns:

true if we have that column

setQueryTimeOutSeconds

@Nonnull
public CSQL setQueryTimeOutSeconds(@Nonnegative
                                            int seconds)

Sets the number of seconds the driver will wait for a Statement object to execute to the given number of seconds. If the limit is exceeded, an SQLException is thrown. A JDBC driver must apply this limit to the execute, executeQuery and executeUpdate methods. JDBC driver implementations may also apply this limit to ResultSet methods (consult your driver vendor documentation for details).

Parameters:

seconds - the new query timeout limit in seconds; ZERO means there is no limit

Returns:

this

execute

public void execute(@Syntax(value="SQL") @Nonnull
                    java.lang.String inSql)
             throws java.sql.SQLException

Parameters:

inSql - the SQL

Throws:

java.sql.SQLException - a serious problem

addBatch

@Nonnull
public CSQL addBatch(@Syntax(value="SQL") @Nonnull
                              java.lang.String theSql)
                       throws java.sql.SQLException

Batch batchStatement

Parameters:

theSql - sql batchStatement

Returns:

this

Throws:

java.sql.SQLException - a database problem

addPreparedStatement

@Nonnull
public CSQL addPreparedStatement(@Syntax(value="SQL") @Nonnull
                                          java.lang.String statement,
                                          java.lang.Object... args)
                                   throws java.sql.SQLException

add prepared statement

Parameters:

statement - SQL batchStatement

args - the arguments to use.

Returns:

this

Throws:

java.sql.SQLException - a database problem

executeBatch

@Nonnull
public int[] executeBatch()
                            throws java.sql.SQLException

Execute batch batchStatement

Returns:

the rows

Throws:

java.sql.SQLException - a database problem

recordTime

public static void recordTime(@Nullable
                              java.lang.Object inObj,
                              @Nonnull
                              Lap lap,
                              @Nullable
                              java.sql.Connection conn,
                              @Nullable
                              java.lang.Throwable e,
                              int rows,
                              @Nonnull
                              DataBase dataBase)

Record the SQL time

Parameters:

inObj - The SQL

lap - When did we start ?

conn - The connection

e - the exception

rows - the number of rows

dataBase - the current database.

hasWarnings

@CheckReturnValue
public boolean hasWarnings()

Returns:

true if there is some warnings.

getFirstWarning

@CheckReturnValue
 @Nullable
public java.sql.SQLWarning getFirstWarning(@Nonnull
                                                                        java.sql.Statement stmt)
                                                                 throws java.lang.Exception

Parameters:

stmt - the batchStatement

Returns:

the first warning

Throws:

java.lang.Exception - a serious problem

getWarningText

@CheckReturnValue
 @Nonnull
public java.lang.String getWarningText()

Returns:

the warning text

loadResults

public int loadResults(@Nonnull
                       java.sql.Statement stmt)
                throws java.lang.Exception

Specified by:

loadResults in interface ResultsLoader

Parameters:

stmt - the batchStatement

Returns:

the number of rows

Throws:

java.lang.Exception - a serious problem

nextResults

@CheckReturnValue
 @Nullable
public CSQL nextResults()

Returns:

the next results

hasMoreResults

@CheckReturnValue
 @Nonnull
public boolean hasMoreResults()

Returns:

true if more results

getSQL

@CheckReturnValue
 @Nonnull
 @Syntax(value="SQL")
public java.lang.String getSQL()

Returns:

the SQL

perform

@Nonnull
public CSQL perform(@Syntax(value="SQL") @Nonnull
                             java.lang.String inSql)
                      throws java.sql.SQLException

performs the SQL batchStatement passed. We examine the batchStatement to check if it's a SELECT type batchStatement and if so request the record set.

Parameters:

inSql - the SQL

Returns:

this

Throws:

java.sql.SQLException - a serious problem

findOne

@Nonnull
public CSQL findOne(@Syntax(value="SQL") @Nonnull
                             java.lang.String theSelect)
                      throws java.sql.SQLException,
                             NotFoundException

Parameters:

theSelect - the select

Returns:

this

Throws:

java.sql.SQLException - a serious problem

NotFoundException - not found

setMaxRow

@Nonnull
public CSQL setMaxRow(int maxRow)

Parameters:

maxRow - the max number of rows.

Returns:

this

hasOutput

@CheckReturnValue
public boolean hasOutput()

Returns true if the batchStatement was a select type of batchStatement

Returns:

true if there is output

encodeTableData

@CheckReturnValue
 @Nullable
public java.lang.String encodeTableData(boolean header_fg)
                                                              throws java.sql.SQLException

Produces a tab separated data string. Data is produced with or with out header info ( encoded not to include tabs in data)

Parameters:

header_fg - include header

Returns:

the encoded data

Throws:

java.sql.SQLException - a serious problem

incrementHitCount

@Nonnegative
public static long incrementHitCount()

Increment hit count

Returns:

The increment hit count

getHitCount

@CheckReturnValue
 @Nonnegative
public static long getHitCount()

The hit count

Returns:

the hit count

getHitRowCount

@CheckReturnValue
 @Nonnegative
public static long getHitRowCount()

The hit ROW count

Returns:

the hit ROW count

incrementLargeHitCount

@Nonnegative
public static long incrementLargeHitCount()

Increment hit count

Returns:

The incremented hit count

getLargeHitCount

@CheckReturnValue
 @Nonnegative
public static long getLargeHitCount()

The hit count

Returns:

the hit count

encodeTableData

@CheckReturnValue
 @Nullable
public java.lang.String encodeTableData(boolean header_fg,
                                                                     int whichRow,
                                                                     java.util.List restrictCols)
                                                              throws java.sql.SQLException

With addition option of a row ( -1 for all rows) and only some columns

Parameters:

header_fg - include header

whichRow - which row

restrictCols - the columns

Returns:

the encoded data

Throws:

java.sql.SQLException - a serious problem

clear

protected void clear()

Overrides:

clear in class SResultSet