Modifier and Type	Class and Description
pack-priv class	Database.CheckpointRunner
pack-priv static class	Database.TimeoutRunner Sessions running a statement with timeout are added to the list.

Field Summary

Modifier and Type	Field and Description
private final String	canonicalPath
public Database.CheckpointRunner	checkpointRunner
public static final int	CLOSEMODE_COMPACT
public static final int	CLOSEMODE_IMMEDIATELY
public static final int	CLOSEMODE_NORMAL
public static final int	CLOSEMODE_SCRIPT
public Collation	collation
public static final int	DATABASE_CLOSING
public static final int	DATABASE_ONLINE
public static final int	DATABASE_OPENING
public static final int	DATABASE_SHUTDOWN
pack-priv int	databaseID
public HsqlDatabaseProperties	databaseProperties
pack-priv boolean	databaseReadOnly true means that all tables are readonly.
pack-priv DatabaseType	databaseType
pack-priv HsqlNameManager.HsqlName	databaseUniqueName
public DatabaseInformation	dbInfo
private volatile int	dbState indicates the state of the database
public int	defaultIsolationLevel
private boolean	filesInJar true means filesReadOnly
private boolean	filesReadOnly true means that all CACHED and TEXT tables are readonly.
public GranteeManager	granteeManager
private boolean	isReferentialIntegrity
public LobManager	lobManager
public Logger	logger
public HsqlNameManager	nameManager
private final String	path
public PersistentStoreCollectionDatabase	persistentStoreCollection
public int	recoveryMode
pack-priv int	resultMaxMemoryRows
public SchemaManager	schemaManager
public SessionManager	sessionManager
private final boolean	shutdownOnNoConnection
public int	sqlAvgScale Defaults are used in version upgrades, but overridden by databaseProperties or URL properties for new databases.
public boolean	sqlCharLiteral
public boolean	sqlConcatNulls
public boolean	sqlConvertTruncate
public boolean	sqlDoubleNaN
public boolean	sqlEnforceNames
public boolean	sqlEnforceRefs
public boolean	sqlEnforceSize
public boolean	sqlEnforceTDCD
public boolean	sqlEnforceTDCU
public boolean	sqlEnforceTypes
public boolean	sqlIgnoreCase
public boolean	sqlLiveObject
public boolean	sqlLongvarIsLob
public boolean	sqlLowerCaseIdentifier
public int	sqlMaxRecursive
public boolean	sqlNullsFirst
public boolean	sqlNullsOrder
public boolean	sqlRegularNames
public boolean	sqlRestrictExec
public boolean	sqlSyntaxDb2
public boolean	sqlSyntaxMss
public boolean	sqlSyntaxMys
public boolean	sqlSyntaxOra
public boolean	sqlSyntaxPgs
public boolean	sqlSysIndexNames
public boolean	sqlTranslateTTI
public boolean	sqlTruncateTrailing
public boolean	sqlUniqueNulls
public Database.TimeoutRunner	timeoutRunner
public boolean	txConflictRollback
public boolean	txInterruptRollback
public TransactionManager	txManager
pack-priv Result	updateZeroResult
public HsqlProperties	urlProperties
public UserManager	userManager

Constructor Summary

Access	Constructor and Description
pack-priv	Database(DatabaseType is the type of the database: "mem:", "file:", "res:" type, String is the given path to the database files path, String is the canonical path canonicalPath, HsqlProperties property overrides placed on the connect URL props) Constructs a new Database object.

Method Summary

Modifier and Type	Method and Description
pack-priv void	clearStructures() Clears the data structures, making them elligible for garbage collection.
public void	close(int closemode) Closes this Database using the specified mode.
pack-priv void	closeIfLast()
pack-priv synchronized Session	connect(String username, String password, TimeZone zone) Constructs a new Session that operates within (is connected to) the context of this Database object.
public void	createObjectStructures()
public String	getCanonicalPath()
public HsqlNameManager.HsqlName	getCatalogName()
public int	getDatabaseID() Returns the database ID.
public GranteeManager	getGranteeManager() Returns the GranteeManager for this Database.
public HsqlNameManager.HsqlName	getName()
public String	getNameString() Returns a unique String identifier for the database.
public String	getPath() Returns the path of the database
public HsqlDatabaseProperties	getProperties() Returns the database properties.
public int	getResultMaxMemoryRows()
public Result	getScript(boolean indexRoots) Returns the schema and authorisation statements for the database.
public SessionManager	getSessionManager() Returns the SessionManager for the database.
public List<String>	getSettingsSQLArray()
pack-priv int	getState()
pack-priv String	getStateString()
public Database.TimeoutRunner	getTimeoutRunner()
public DatabaseType	getType() Returns the type of the database: "mem", "file", "res"
public String	getURI()
public HsqlProperties	getURLProperties()
public UserManager	getUserManager() Returns the UserManager for this Database.
public boolean	isFilesInJar() Is this in filesInJar mode?
public boolean	isFilesReadOnly() Is this in filesReadOnly mode?
public boolean	isReadOnly()
public boolean	isReferentialIntegrity() Is referential integrity currently enforced?
pack-priv boolean	isShutdown() Returns true if database has been shut down, false otherwise
pack-priv synchronized void	open() Opens this database.
pack-priv void	reopen() Opens this database.
public void	setAvgScale(int scale)
public void	setCharacterLiteral(boolean mode)
public void	setConcatNulls(boolean mode)
public void	setConvertTrunc(boolean mode)
public void	setDatabaseName(String name)
public void	setDoubleNaN(boolean mode)
public void	setFilesReadOnly() After this call all CACHED and TEXT tables will be set to read-only mode.
public void	setIgnoreCase(boolean mode)
public void	setLiveObject(boolean mode)
public void	setLongVarIsLob(boolean mode)
public void	setLowerCaseIndentifer(boolean mode)
public void	setMaxRecursive(int value)
public void	setNullsFirst(boolean mode)
public void	setNullsOrder(boolean mode)
public void	setReadOnly() Puts this Database object in global read-only mode.
public void	setReferentialIntegrity(boolean ref) Sets the isReferentialIntegrity attribute.
public void	setRegularNames(boolean mode)
public void	setRestrictExec(boolean mode)
public void	setResultMaxMemoryRows(int size)
private void	setState(int state)
public void	setStrictColumnSize(boolean mode)
public void	setStrictNames(boolean mode)
public void	setStrictReferences(boolean mode)
public void	setStrictTDCD(boolean mode)
public void	setStrictTDCU(boolean mode)
public void	setStrictTypes(boolean mode)
public void	setSyntaxDb2(boolean mode)
public void	setSyntaxMss(boolean mode)
public void	setSyntaxMys(boolean mode)
public void	setSyntaxOra(boolean mode)
public void	setSyntaxPgs(boolean mode)
public void	setSysIndexNames(boolean mode)
public void	setTranslateTTI(boolean mode)
public void	setTruncateTrailing(boolean mode)
public void	setUniqueNulls(boolean mode)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

canonicalPath	back to summary
private final String canonicalPath

checkpointRunner	back to summary
public Database.CheckpointRunner checkpointRunner

CLOSEMODE_COMPACT	back to summary
public static final int CLOSEMODE_COMPACT

CLOSEMODE_IMMEDIATELY	back to summary
public static final int CLOSEMODE_IMMEDIATELY

CLOSEMODE_NORMAL	back to summary
public static final int CLOSEMODE_NORMAL

CLOSEMODE_SCRIPT	back to summary
public static final int CLOSEMODE_SCRIPT

collation	back to summary
public Collation collation

DATABASE_CLOSING	back to summary
public static final int DATABASE_CLOSING

DATABASE_ONLINE	back to summary
public static final int DATABASE_ONLINE

DATABASE_OPENING	back to summary
public static final int DATABASE_OPENING

DATABASE_SHUTDOWN	back to summary
public static final int DATABASE_SHUTDOWN

databaseID	back to summary
pack-priv int databaseID

databaseProperties	back to summary
public HsqlDatabaseProperties databaseProperties

databaseReadOnly	back to summary
pack-priv boolean databaseReadOnly true means that all tables are readonly.

databaseType	back to summary
pack-priv DatabaseType databaseType

databaseUniqueName	back to summary
pack-priv HsqlNameManager.HsqlName databaseUniqueName

dbInfo	back to summary
public DatabaseInformation dbInfo

dbState	back to summary
private volatile int dbState indicates the state of the database

defaultIsolationLevel	back to summary
public int defaultIsolationLevel

filesInJar	back to summary
private boolean filesInJar true means filesReadOnly

filesReadOnly	back to summary
private boolean filesReadOnly true means that all CACHED and TEXT tables are readonly. MEMORY tables are updatable but updates are not persisted.

granteeManager	back to summary
public GranteeManager granteeManager

isReferentialIntegrity	back to summary
private boolean isReferentialIntegrity

lobManager	back to summary
public LobManager lobManager

logger	back to summary
public Logger logger

nameManager	back to summary
public HsqlNameManager nameManager

path	back to summary
private final String path

persistentStoreCollection	back to summary
public PersistentStoreCollectionDatabase persistentStoreCollection

recoveryMode	back to summary
public int recoveryMode

resultMaxMemoryRows	back to summary
pack-priv int resultMaxMemoryRows

schemaManager	back to summary
public SchemaManager schemaManager

sessionManager	back to summary
public SessionManager sessionManager

shutdownOnNoConnection	back to summary
private final boolean shutdownOnNoConnection

sqlAvgScale	back to summary
public int sqlAvgScale Defaults are used in version upgrades, but overridden by databaseProperties or URL properties for new databases.

sqlCharLiteral	back to summary
public boolean sqlCharLiteral

sqlConcatNulls	back to summary
public boolean sqlConcatNulls

sqlConvertTruncate	back to summary
public boolean sqlConvertTruncate

sqlDoubleNaN	back to summary
public boolean sqlDoubleNaN

sqlEnforceNames	back to summary
public boolean sqlEnforceNames

sqlEnforceRefs	back to summary
public boolean sqlEnforceRefs

sqlEnforceSize	back to summary
public boolean sqlEnforceSize

sqlEnforceTDCD	back to summary
public boolean sqlEnforceTDCD

sqlEnforceTDCU	back to summary
public boolean sqlEnforceTDCU

sqlEnforceTypes	back to summary
public boolean sqlEnforceTypes

sqlIgnoreCase	back to summary
public boolean sqlIgnoreCase

sqlLiveObject	back to summary
public boolean sqlLiveObject

sqlLongvarIsLob	back to summary
public boolean sqlLongvarIsLob

sqlLowerCaseIdentifier	back to summary
public boolean sqlLowerCaseIdentifier

sqlMaxRecursive	back to summary
public int sqlMaxRecursive

sqlNullsFirst	back to summary
public boolean sqlNullsFirst

sqlNullsOrder	back to summary
public boolean sqlNullsOrder

sqlRegularNames	back to summary
public boolean sqlRegularNames

sqlRestrictExec	back to summary
public boolean sqlRestrictExec

sqlSyntaxDb2	back to summary
public boolean sqlSyntaxDb2

sqlSyntaxMss	back to summary
public boolean sqlSyntaxMss

sqlSyntaxMys	back to summary
public boolean sqlSyntaxMys

sqlSyntaxOra	back to summary
public boolean sqlSyntaxOra

sqlSyntaxPgs	back to summary
public boolean sqlSyntaxPgs

sqlSysIndexNames	back to summary
public boolean sqlSysIndexNames

sqlTranslateTTI	back to summary
public boolean sqlTranslateTTI

sqlTruncateTrailing	back to summary
public boolean sqlTruncateTrailing

sqlUniqueNulls	back to summary
public boolean sqlUniqueNulls

timeoutRunner	back to summary
public Database.TimeoutRunner timeoutRunner

txConflictRollback	back to summary
public boolean txConflictRollback

txInterruptRollback	back to summary
public boolean txInterruptRollback

txManager	back to summary
public TransactionManager txManager

updateZeroResult	back to summary
pack-priv Result updateZeroResult

urlProperties	back to summary
public HsqlProperties urlProperties

userManager	back to summary
public UserManager userManager

Constructor Detail

Database

back to summary

pack-priv Database(DatabaseType type, String path, String canonicalPath, HsqlProperties props)

Constructs a new Database object.

Parameters

type:DatabaseType: is the type of the database: "mem:", "file:", "res:"
path:String: is the given path to the database files
canonicalPath:String: is the canonical path
props:HsqlProperties: property overrides placed on the connect URL

Exceptions

HsqlException:: if the specified name and path combination is illegal or unavailable, or the database files the name and path resolves to are in use by another process

Method Detail

clearStructures	back to summary
pack-priv void clearStructures() Clears the data structures, making them elligible for garbage collection.

back to summary

public void close(int closemode)

Closes this Database using the specified mode.

closemode -1 performs SHUTDOWN IMMEDIATELY, equivalent to a poweroff or crash.
closemode 0 performs a normal SHUTDOWN that checkpoints the database normally.
closemode 1 performs a shutdown compact that scripts out the contents of any CACHED tables to the log then deletes the existing *.data file that contains the data for all CACHED table before the normal checkpoint process which in turn creates a new, compact *.data file.

closeIfLast	back to summary
pack-priv void closeIfLast()

connect

back to summary

pack-priv synchronized Session connect(String username, String password, TimeZone zone)

Constructs a new Session that operates within (is connected to) the context of this Database object.

If successful, the new Session object initially operates on behalf of the user specified by the supplied user name. Throws if username or password is invalid.

createObjectStructures	back to summary
public void createObjectStructures()

getCanonicalPath	back to summary
public String getCanonicalPath()

getCatalogName	back to summary
public HsqlNameManager.HsqlName getCatalogName()

getDatabaseID	back to summary
public int getDatabaseID() Returns the database ID.

getGranteeManager	back to summary
public GranteeManager getGranteeManager() Returns the GranteeManager for this Database.

getName	back to summary
public HsqlNameManager.HsqlName getName()

getNameString	back to summary
public String getNameString() Returns a unique String identifier for the database.

getPath	back to summary
public String getPath() Returns the path of the database

getProperties	back to summary
public HsqlDatabaseProperties getProperties() Returns the database properties.

getResultMaxMemoryRows	back to summary
public int getResultMaxMemoryRows()

getScript	back to summary
public Result getScript(boolean indexRoots) Returns the schema and authorisation statements for the database.

getSessionManager	back to summary
public SessionManager getSessionManager() Returns the SessionManager for the database.

getSettingsSQLArray	back to summary
public List<String> getSettingsSQLArray()

getState	back to summary
pack-priv int getState()

getStateString	back to summary
pack-priv String getStateString()

getTimeoutRunner	back to summary
public Database.TimeoutRunner getTimeoutRunner()

getType	back to summary
public DatabaseType getType() Returns the type of the database: "mem", "file", "res"

getURI	back to summary
public String getURI()

getURLProperties	back to summary
public HsqlProperties getURLProperties()

getUserManager	back to summary
public UserManager getUserManager() Returns the UserManager for this Database.

isFilesInJar	back to summary
public boolean isFilesInJar() Is this in filesInJar mode?

isFilesReadOnly	back to summary
public boolean isFilesReadOnly() Is this in filesReadOnly mode?

isReadOnly	back to summary
public boolean isReadOnly()

isReferentialIntegrity	back to summary
public boolean isReferentialIntegrity() Is referential integrity currently enforced?

isShutdown	back to summary
pack-priv boolean isShutdown() Returns true if database has been shut down, false otherwise

open	back to summary
pack-priv synchronized void open() Opens this database. The database should be opened after construction.

reopen	back to summary
pack-priv void reopen() Opens this database. The database should be opened after construction. or reopened by the close(int closemode) method during a "shutdown compact". Closes the log if there is an error.

setAvgScale	back to summary
public void setAvgScale(int scale)

setCharacterLiteral	back to summary
public void setCharacterLiteral(boolean mode)

setConcatNulls	back to summary
public void setConcatNulls(boolean mode)

setConvertTrunc	back to summary
public void setConvertTrunc(boolean mode)

setDatabaseName	back to summary
public void setDatabaseName(String name)

setDoubleNaN	back to summary
public void setDoubleNaN(boolean mode)

setFilesReadOnly	back to summary
public void setFilesReadOnly() After this call all CACHED and TEXT tables will be set to read-only mode. Changes to MEMORY tables will NOT be stored or updated in the script file. This mode is intended for use with read-only media where data should not be persisted.

setIgnoreCase	back to summary
public void setIgnoreCase(boolean mode)

setLiveObject	back to summary
public void setLiveObject(boolean mode)

setLongVarIsLob	back to summary
public void setLongVarIsLob(boolean mode)

setLowerCaseIndentifer	back to summary
public void setLowerCaseIndentifer(boolean mode)

setMaxRecursive	back to summary
public void setMaxRecursive(int value)

setNullsFirst	back to summary
public void setNullsFirst(boolean mode)

setNullsOrder	back to summary
public void setNullsOrder(boolean mode)

setReadOnly	back to summary
public void setReadOnly() Puts this Database object in global read-only mode. After this call, all existing and future sessions are limited to read-only transactions. Any following attempts to update the state of the database will result in throwing an HsqlException.

setReferentialIntegrity	back to summary
public void setReferentialIntegrity(boolean ref) Sets the isReferentialIntegrity attribute.

setRegularNames	back to summary
public void setRegularNames(boolean mode)

setRestrictExec	back to summary
public void setRestrictExec(boolean mode)

setResultMaxMemoryRows	back to summary
public void setResultMaxMemoryRows(int size)

setState	back to summary
private void setState(int state)

setStrictColumnSize	back to summary
public void setStrictColumnSize(boolean mode)

setStrictNames	back to summary
public void setStrictNames(boolean mode)

setStrictReferences	back to summary
public void setStrictReferences(boolean mode)

setStrictTDCD	back to summary
public void setStrictTDCD(boolean mode)

setStrictTDCU	back to summary
public void setStrictTDCU(boolean mode)

setStrictTypes	back to summary
public void setStrictTypes(boolean mode)

setSyntaxDb2	back to summary
public void setSyntaxDb2(boolean mode)

setSyntaxMss	back to summary
public void setSyntaxMss(boolean mode)

setSyntaxMys	back to summary
public void setSyntaxMys(boolean mode)

setSyntaxOra	back to summary
public void setSyntaxOra(boolean mode)

setSyntaxPgs	back to summary
public void setSyntaxPgs(boolean mode)

setSysIndexNames	back to summary
public void setSysIndexNames(boolean mode)

setTranslateTTI	back to summary
public void setTranslateTTI(boolean mode)

setTruncateTrailing	back to summary
public void setTruncateTrailing(boolean mode)

setUniqueNulls	back to summary
public void setUniqueNulls(boolean mode)

org.hsqldb back to summary

pack-priv Class Database.CheckpointRunner

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.hsqldb.Database.CheckpointRunner

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private Object	timerTask
private volatile boolean	waiting

Constructor Summary

Access	Constructor and Description
pack-priv	CheckpointRunner()

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public void	start()
public void	stop()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

timerTask	back to summary
private Object timerTask

waiting	back to summary
private volatile boolean waiting

Constructor Detail

CheckpointRunner	back to summary
pack-priv CheckpointRunner()

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

start	back to summary
public void start()

stop	back to summary
public void stop()

org.hsqldb back to summary

pack-priv Class Database.TimeoutRunner

Class Inheritance

extends Object
implements Runnable

java.lang.Object
org.hsqldb.Database.TimeoutRunner

All Implemented Interfaces

java.lang.Runnable

Sessions running a statement with timeout are added to the list. The first session starts the runner. Sessions are not removed until closed.

The runner is called at second intervals. It handles the countdown for each session currently running a statement with timeout. If timeout is reached, the runner aborts the statement.

Field Summary

Modifier and Type	Field and Description
pack-priv int	abortCount
private HsqlArrayList<Session.TimeoutManager>	timeoutList
private Object	timerTask

Constructor Summary

Access	Constructor and Description
pack-priv	TimeoutRunner()

Method Summary

Modifier and Type	Method and Description
public void	addSession(Session.TimeoutManager timeout)
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	start()
public void	stop()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

abortCount	back to summary
pack-priv int abortCount

timeoutList	back to summary
private HsqlArrayList<Session.TimeoutManager> timeoutList

timerTask	back to summary
private Object timerTask

Constructor Detail

TimeoutRunner	back to summary
pack-priv TimeoutRunner()

Method Detail

addSession	back to summary
public void addSession(Session.TimeoutManager timeout)

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

start	back to summary
private void start()

stop	back to summary
public void stop()

public Class Database

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Database.CheckpointRunner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Database.TimeoutRunner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail