org.hsqldb

Class Session

java.lang.Object

org.hsqldb.Session

All Implemented Interfaces:

SessionInterface

public class Session
extends java.lang.Object
implements SessionInterface

Implementation of SQL sessions.

Since:

1.7.0

Field Summary

Fields

Modifier and Type	Field and Description
HsqlNameManager.HsqlName	currentSchema
Database	database
boolean	isReadOnlyDefault
CountUpDownLatch	latch
HsqlNameManager.HsqlName	loggedSchema
SessionContext	sessionContext
SessionData	sessionData
StatementManager	statementManager
OrderedHashSet	waitedSessions
OrderedHashSet	waitingSessions

Fields inherited from interface org.hsqldb.SessionInterface

INFO_AUTOCOMMIT, INFO_BOOLEAN, INFO_CATALOG, INFO_CONNECTION_READONLY, INFO_ID, INFO_INTEGER, INFO_ISOLATION, INFO_LIMIT, INFO_VARCHAR, lobStreamBlockSize, TX_READ_COMMITTED, TX_READ_UNCOMMITTED, TX_REPEATABLE_READ, TX_SERIALIZABLE

Method Summary

Modifier and Type	Method and Description
void	addDeleteAction(Table table, PersistentStore store, Row row, int[] colMap) Adds a delete action to the row and the transaction manager.
void	addWarning(HsqlException warning)
void	allocateResultLob(ResultLob result, java.io.InputStream inputStream)
void	beginAction(Statement cs)
void	clearWarnings()
void	close() Closes this Session.
void	closeNavigator(long id)
void	commit(boolean chain) Commits any uncommited transaction this Session may have open
Statement	compileStatement(java.lang.String sql)
Statement	compileStatement(java.lang.String sql, int props)
BlobDataID	createBlob(long length)
ClobDataID	createClob(long length)
void	endAction(Result result)
Result	execute(Result cmd) Executes the command encapsulated by the cmd argument.
Result	executeCompiledStatement(Statement cs, java.lang.Object[] pvals, int timeout)
Result	executeDirectStatement(Result cmd)
Result	executeDirectStatement(java.lang.String sql)
long	getActionTimestamp()
HsqlException[]	getAndClearWarnings()
java.lang.Object	getAttribute(int id)
java.util.Calendar	getCalendar()
java.util.Calendar	getCalendarGMT()
HsqlProperties	getClientProperties()
Type.TypedComparator	getComparator()
long	getConnectTime() Getter for connectTime attribute.
TimestampData	getCurrentDate() Returns the current date, unchanged for the duration of the current execution unit (statement).
HsqlNameManager.HsqlName	getCurrentSchemaHsqlName()
Database	getDatabase() Retrieves the Database instance to which this Session represents a connection.
java.lang.String	getDatabaseUniqueName()
Grantee	getGrantee()
long	getId() Retrieves the session identifier for this Session.
java.lang.String	getInternalConnectionURL()
int	getIsolation()
JDBCConnection	getJDBCConnection() Retreives the external JDBC connection
java.lang.Number	getLastIdentity() Getter for iLastIdentity attribute.
HsqlException	getLastWarning()
int	getResultMemoryRowCount()
Grantee	getRole()
RowSetNavigatorClient	getRows(long navigatorId, int offset, int blockSize)
Scanner	getScanner()
java.lang.String	getSchemaName(java.lang.String name) Same as above, but return string
java.text.SimpleDateFormat	getSimpleDateFormatGMT()
int	getStreamBlockSize()
int	getTransactionSize() Count of acctions in current transaction.
long	getTransactionTimestamp()
User	getUser() Retrieves the User object representing the user currently controlling this Session.
java.lang.String	getUsername() Retrieves the name, as known to the database, of the user currently controlling this Session.
int	getZoneSeconds()
boolean	hasLocks(Statement statement)
boolean	isAdmin() Getter for admin attribute.
boolean	isAutoCommit() Getter for autoCommit attribute.
boolean	isClosed() Retrieves whether this Session is closed.
boolean	isIgnorecase()
boolean	isInMidTransaction()
boolean	isReadOnly() Getter for readonly attribute.
boolean	isReadOnlyDefault()
void	prepareCommit()
double	random()
double	random(long seed)
void	registerResultLobs(Result result)
void	releaseSavepoint(java.lang.String name) Releases a savepoint
void	resetSession() Clear structures and reset variables to original.
void	rollback(boolean chain) Rolls back any uncommited transaction this Session may have open.
void	rollbackAction(int start, long timestamp)
void	rollbackToSavepoint() Performs a partial transaction ROLLBACK of current savepoint level.
void	rollbackToSavepoint(java.lang.String name) Performs a partial transaction ROLLBACK to savepoint.
void	savepoint(java.lang.String name) Registers a transaction SAVEPOINT.
void	setAttribute(int id, java.lang.Object object)
void	setAutoCommit(boolean autocommit) Setter for the autocommit attribute.
void	setCatalog(java.lang.String catalog)
void	setCurrentSchemaHsqlName(HsqlNameManager.HsqlName name)
void	setIgnoreCase(boolean mode)
void	setIsolation(int level) sets ISOLATION for the next transaction only
void	setIsolationDefault(int level)
void	setJDBCConnection(JDBCConnection connection)
void	setNoSQL()
void	setReadOnly(boolean readonly) sets READ ONLY for next transaction / subtransaction only
void	setReadOnlyDefault(boolean readonly)
void	setResultMemoryRowCount(int count)
void	setRole(Grantee role)
void	setSchema(java.lang.String schema)
void	setUser(User user) Sets this Session's User object to the one specified by the user argument.
void	setZoneSeconds(int seconds)
void	startPhasedTransaction()
void	startTransaction()

Methods inherited from class java.lang.Object

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

Field Detail

database

public Database database

isReadOnlyDefault

public boolean isReadOnlyDefault

waitedSessions

public OrderedHashSet waitedSessions

waitingSessions

public OrderedHashSet waitingSessions

latch

public CountUpDownLatch latch

currentSchema

public HsqlNameManager.HsqlName currentSchema

loggedSchema

public HsqlNameManager.HsqlName loggedSchema

sessionContext

public SessionContext sessionContext

sessionData

public SessionData sessionData

statementManager

public StatementManager statementManager

Method Detail

getId

public long getId()

Retrieves the session identifier for this Session.

Specified by:

getId in interface SessionInterface

Returns:

the session identifier for this Session

close

public void close()

Closes this Session.

Specified by:

close in interface SessionInterface

isClosed

public boolean isClosed()

Retrieves whether this Session is closed.

Specified by:

isClosed in interface SessionInterface

Returns:

true if this Session is closed

setIsolationDefault

public void setIsolationDefault(int level)

Specified by:

setIsolationDefault in interface SessionInterface

setIsolation

public void setIsolation(int level)

sets ISOLATION for the next transaction only

getIsolation

public int getIsolation()

Specified by:

getIsolation in interface SessionInterface

getLastIdentity

public java.lang.Number getLastIdentity()

Getter for iLastIdentity attribute.

Returns:

the current value

getDatabase

public Database getDatabase()

Retrieves the Database instance to which this Session represents a connection.

Returns:

the Database object to which this Session is connected

getUsername

public java.lang.String getUsername()

Retrieves the name, as known to the database, of the user currently controlling this Session.

Returns:

the name of the user currently connected within this Session

getUser

public User getUser()

Retrieves the User object representing the user currently controlling this Session.

Returns:

this Session's User object

getGrantee

public Grantee getGrantee()

getRole

public Grantee getRole()

setUser

public void setUser(User user)

Sets this Session's User object to the one specified by the user argument.

Parameters:

user - the new User object for this session

setRole

public void setRole(Grantee role)

getActionTimestamp

public long getActionTimestamp()

addDeleteAction

public void addDeleteAction(Table table,
                            PersistentStore store,
                            Row row,
                            int[] colMap)

Adds a delete action to the row and the transaction manager.

Parameters:

table - the table of the row

row - the deleted row

Throws:

HsqlException

setAutoCommit

public void setAutoCommit(boolean autocommit)

Setter for the autocommit attribute.

Specified by:

setAutoCommit in interface SessionInterface

Parameters:

autocommit - the new value

Throws:

HsqlException

beginAction

public void beginAction(Statement cs)

endAction

public void endAction(Result result)

hasLocks

public boolean hasLocks(Statement statement)

startTransaction

public void startTransaction()

startPhasedTransaction

public void startPhasedTransaction()

Specified by:

startPhasedTransaction in interface SessionInterface

prepareCommit

public void prepareCommit()

Specified by:

prepareCommit in interface SessionInterface

commit

public void commit(boolean chain)

Commits any uncommited transaction this Session may have open

Specified by:

commit in interface SessionInterface

Throws:

HsqlException

rollback

public void rollback(boolean chain)

Rolls back any uncommited transaction this Session may have open.

Specified by:

rollback in interface SessionInterface

Throws:

HsqlException

resetSession

public void resetSession()

Clear structures and reset variables to original. For JDBC use only.

Specified by:

resetSession in interface SessionInterface

savepoint

public void savepoint(java.lang.String name)

Registers a transaction SAVEPOINT. A new SAVEPOINT with the name of an existing one replaces the old SAVEPOINT.

Specified by:

savepoint in interface SessionInterface

Parameters:

name - name of the savepoint

Throws:

HsqlException - if there is no current transaction

rollbackToSavepoint

public void rollbackToSavepoint(java.lang.String name)

Performs a partial transaction ROLLBACK to savepoint.

Specified by:

rollbackToSavepoint in interface SessionInterface

Parameters:

name - name of savepoint

Throws:

HsqlException

rollbackToSavepoint

public void rollbackToSavepoint()

Performs a partial transaction ROLLBACK of current savepoint level.

Throws:

HsqlException

rollbackAction

public void rollbackAction(int start,
                           long timestamp)

releaseSavepoint

public void releaseSavepoint(java.lang.String name)

Releases a savepoint

Specified by:

releaseSavepoint in interface SessionInterface

Parameters:

name - name of savepoint

Throws:

HsqlException - if name does not correspond to a savepoint

isInMidTransaction

public boolean isInMidTransaction()

setNoSQL

public void setNoSQL()

setIgnoreCase

public void setIgnoreCase(boolean mode)

isIgnorecase

public boolean isIgnorecase()

setReadOnly

public void setReadOnly(boolean readonly)

sets READ ONLY for next transaction / subtransaction only

Parameters:

readonly - the new value

setReadOnlyDefault

public void setReadOnlyDefault(boolean readonly)

Specified by:

setReadOnlyDefault in interface SessionInterface

isReadOnly

public boolean isReadOnly()

Getter for readonly attribute.

Returns:

the current value

isReadOnlyDefault

public boolean isReadOnlyDefault()

Specified by:

isReadOnlyDefault in interface SessionInterface

isAutoCommit

public boolean isAutoCommit()

Getter for autoCommit attribute.

Specified by:

isAutoCommit in interface SessionInterface

Returns:

the current value

getStreamBlockSize

public int getStreamBlockSize()

Specified by:

getStreamBlockSize in interface SessionInterface

getJDBCConnection

public JDBCConnection getJDBCConnection()

Retreives the external JDBC connection

Specified by:

getJDBCConnection in interface SessionInterface

setJDBCConnection

public void setJDBCConnection(JDBCConnection connection)

Specified by:

setJDBCConnection in interface SessionInterface

getDatabaseUniqueName

public java.lang.String getDatabaseUniqueName()

Specified by:

getDatabaseUniqueName in interface SessionInterface

isAdmin

public boolean isAdmin()

Getter for admin attribute.

Returns:

the current value

getConnectTime

public long getConnectTime()

Getter for connectTime attribute.

Returns:

the value

getTransactionSize

public int getTransactionSize()

Count of acctions in current transaction.

Returns:

the current value

getTransactionTimestamp

public long getTransactionTimestamp()

compileStatement

public Statement compileStatement(java.lang.String sql,
                                  int props)

compileStatement

public Statement compileStatement(java.lang.String sql)

execute

public Result execute(Result cmd)

Executes the command encapsulated by the cmd argument.

Specified by:

execute in interface SessionInterface

Parameters:

cmd - the command to execute

Returns:

the result of executing the command

getRows

public RowSetNavigatorClient getRows(long navigatorId,
                                     int offset,
                                     int blockSize)

Specified by:

getRows in interface SessionInterface

closeNavigator

public void closeNavigator(long id)

Specified by:

closeNavigator in interface SessionInterface

executeDirectStatement

public Result executeDirectStatement(Result cmd)

executeDirectStatement

public Result executeDirectStatement(java.lang.String sql)

executeCompiledStatement

public Result executeCompiledStatement(Statement cs,
                                       java.lang.Object[] pvals,
                                       int timeout)

getCurrentDate

public TimestampData getCurrentDate()

Returns the current date, unchanged for the duration of the current execution unit (statement).

SQL standards require that CURRENT_DATE, CURRENT_TIME and CURRENT_TIMESTAMP are all evaluated at the same point of time in the duration of each SQL statement, no matter how long the SQL statement takes to complete.

When this method or a corresponding method for CURRENT_TIME or CURRENT_TIMESTAMP is first called in the scope of a system change number, currentMillis is set to the current system time. All further CURRENT_XXXX calls in this scope will use this millisecond value. (fredt@users)

Specified by:

getCurrentDate in interface SessionInterface

getAttribute

public java.lang.Object getAttribute(int id)

Specified by:

getAttribute in interface SessionInterface

setAttribute

public void setAttribute(int id,
                         java.lang.Object object)

Specified by:

setAttribute in interface SessionInterface

createBlob

public BlobDataID createBlob(long length)

Specified by:

createBlob in interface SessionInterface

createClob

public ClobDataID createClob(long length)

Specified by:

createClob in interface SessionInterface

registerResultLobs

public void registerResultLobs(Result result)

allocateResultLob

public void allocateResultLob(ResultLob result,
                              java.io.InputStream inputStream)

Specified by:

allocateResultLob in interface SessionInterface

getInternalConnectionURL

public java.lang.String getInternalConnectionURL()

Specified by:

getInternalConnectionURL in interface SessionInterface

setSchema

public void setSchema(java.lang.String schema)

setCatalog

public void setCatalog(java.lang.String catalog)

getSchemaName

public java.lang.String getSchemaName(java.lang.String name)

Same as above, but return string

setCurrentSchemaHsqlName

public void setCurrentSchemaHsqlName(HsqlNameManager.HsqlName name)

getCurrentSchemaHsqlName

public HsqlNameManager.HsqlName getCurrentSchemaHsqlName()

getResultMemoryRowCount

public int getResultMemoryRowCount()

setResultMemoryRowCount

public void setResultMemoryRowCount(int count)

addWarning

public void addWarning(HsqlException warning)

Specified by:

addWarning in interface SessionInterface

getAndClearWarnings

public HsqlException[] getAndClearWarnings()

getLastWarning

public HsqlException getLastWarning()

clearWarnings

public void clearWarnings()

getZoneSeconds

public int getZoneSeconds()

Specified by:

getZoneSeconds in interface SessionInterface

setZoneSeconds

public void setZoneSeconds(int seconds)

getCalendar

public java.util.Calendar getCalendar()

Specified by:

getCalendar in interface SessionInterface

getCalendarGMT

public java.util.Calendar getCalendarGMT()

Specified by:

getCalendarGMT in interface SessionInterface

getSimpleDateFormatGMT

public java.text.SimpleDateFormat getSimpleDateFormatGMT()

Specified by:

getSimpleDateFormatGMT in interface SessionInterface

getComparator

public Type.TypedComparator getComparator()

random

public double random(long seed)

random

public double random()

getScanner

public Scanner getScanner()

Specified by:

getScanner in interface SessionInterface

getClientProperties

public HsqlProperties getClientProperties()

Specified by:

getClientProperties in interface SessionInterface