HyperSQL Database 2.7.4 · org.hsqldb.persist.Logger · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public SimpleLog	appLog
public static final String	appLogFileExtension
pack-priv DbBackup	backup
public static final String	backupFileExtension
pack-priv AtomicInteger	backupState
pack-priv AtomicInteger	checkpointState
pack-priv boolean	cryptLobs
private Crypto	crypto
private Database	database
public static final String	dataFileExtension
public FileAccess	fileAccess
public SimpleDateFormat	fileDateFormat
pack-priv FrameworkLogger	fwLogger
public boolean	isNewDatabase
public boolean	isSingleFile
pack-priv static final int	largeDataFactor
public static final String	lobsFileExtension
private LockFile	lockFile
public static final String	lockFileExtension
pack-priv Log	log
public static final String	logFileExtension
private boolean	loggingEnabled
private boolean	logsStatements
pack-priv long	maxLogSize
public static final String	newFileExtension
public static final String	oldFileExtension
private int	propCacheMaxRows
private long	propCacheMaxSize
pack-priv boolean	propCompressLobs
pack-priv int	propDataFileDefragLimit
private int	propDataFileScale
pack-priv int	propDataFileSpace
public static final String	propertiesFileExtension
private int	propEventLogLevel
private int	propExternalEventLogLevel
pack-priv long	propFilesTimestamp
pack-priv int	propGC
private boolean	propIsFileDatabase
pack-priv boolean	propLargeData
pack-priv int	propLobBlockSize
private boolean	propLogData
private int	propLogSize
pack-priv int	propMaxFreeBlocks
pack-priv boolean	propNioDataFile
pack-priv long	propNioMaxSize
pack-priv boolean	propRefIntegrity
pack-priv int	propScriptFormat
pack-priv int	propSqlLogLevel
pack-priv boolean	propTextAllowFullPath
pack-priv String	propTextSourceDefault
pack-priv int	propTxMode
private int	propWriteDelay
private static final char	runtimeFileDelim
public static final String	scriptFileExtension
public SimpleLog	sqlLog
public static final String	sqlLogFileExtension
pack-priv FrameworkLogger	sqlLogger
pack-priv static final int	stateBackup
pack-priv static final int	stateCheckpoint
pack-priv static final int	stateCheckpointDue
pack-priv static final int	stateCheckpointNormal
pack-priv static final int	stateCheckpointRequired
pack-priv static final int	stateNormal
pack-priv String	tempDirectoryPath
public TextTableStorageManager	textTableManager

Constructor Summary

Access	Constructor and Description
public	Logger(Database database)

Method Summary

Modifier and Type	Method and Description
public void	acquireLock(String path)
public void	backup(String destPath, boolean script, boolean blocking, boolean compressed, boolean files)
pack-priv void	backupInternal(String destPath, boolean script, boolean blocking, boolean compressed, boolean asFiles)
public void	checkpoint(Session session, boolean defrag, boolean lobs) Checkpoints the database.
private void	checkpointInternal(Session session, boolean defrag)
pack-priv static void	checkPower(int n, int max)
public boolean	Returns: true if closed with no problems or false if a problem was encountered. close(int The mode in which to shut down the logging process CLOSEMODE_IMMEDIATELY performs SHUTDOWN IMMEDIATELY, equivalent to a poweroff or crash. CLOSEMODE_NORMAL performs a normal SHUTDOWN that checkpoints the database normally. CLOSEMODE_COMPACT 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. CLOSEMODE_SCRIPT performs a SHUTDOWN SCRIPT. closemode) Shuts down the logging process using the specified mode.
public DataFileCache	getCache() Returns the Cache object or null if one doesn't exist.
public int	getCacheMaxRows()
public long	getCacheSize()
public Crypto	getCrypto()
public int	getDataFileFactor()
public int	getDataFileScale()
public int	getDataFileSpace()
public int	getDefragLimit()
private void	getEventLogger() All usage of FrameworkLogger should call this method before using an instance.
public FileAccess	getFileAccess()
public long	getFilesTimestamp()
public int	getLobBlockSize()
public int	getLobFileScale()
public int	getLogSize()
public List<String>	getPropertiesSQLArray(boolean indexRoots)
public HashMap<String, String>	getPropertyValueMap()
public String	getSecurePath(String path, boolean allowFull, boolean includeRes) Returns a secure path or null for a user-defined path when hsqldb.allow_full_path is false.
public int	getSqlEventLogLevel()
public String	getTempDirectoryPath()
public int	getWriteDelay()
public boolean	hasCache() Returns true if Cache object exists.
public boolean	hasLockFile()
public boolean	isAllowedFullPath()
public boolean	isCurrentlyLogged()
public boolean	isFileDatabase()
public boolean	isLogged()
public boolean	isNewDatabase()
public void	logDetailEvent(String message) Implements org.hsqldb.lib.EventLogInterface.logDetailEvent.
public void	logInfoEvent(String message) Implements org.hsqldb.lib.EventLogInterface.logInfoEvent.
public void	logSevereEvent(String message, Throwable t) Implements org.hsqldb.lib.EventLogInterface.logSevereEvent.
public void	logStatementEvent(Session session, Statement statement, Object[] paramValues, Result result, int level)
public void	logWarningEvent(String message, Throwable t) Implements org.hsqldb.lib.EventLogInterface.logWarningEvent.
public boolean	needsCheckpointReset()
public Index	newIndex(HsqlNameManager.HsqlName name, long id, TableBase table, int[] columns, boolean[] descending, boolean[] nullsLast, Type[] colTypes, boolean pk, boolean unique, boolean constraint, boolean forward)
public PersistentStore	newStore(Session session, PersistentStoreCollection collection, TableBase table)
pack-priv String	newUniqueName()
public void	open() Opens the specified Database object's database files and starts up the logging process.
public void	releaseLock()
public void	setCacheMaxRows(int value)
public void	setCacheSize(int value)
public void	setCheckpointRequired()
public void	setDataFileScale(int value)
public void	setDataFileScaleNoCheck(int value)
public void	setDataFileSpace(boolean value)
public void	setDataFileSpace(int value)
public void	setDefagLimit(int value)
public void	setDefaultTextTableProperties(String source, HsqlProperties props)
public void	setEventLogLevel(int level)
public void	setExternalEventLogLevel(int level)
public void	setFilesTimestamp(long value)
public void	setLobFileCompressed(boolean value)
public void	setLobFileCompressedNoCheck(boolean value)
public void	setLobFileScale(int value)
public void	setLobFileScaleNoCheck(int value)
public synchronized void	setLogData(boolean mode) Sets logging on or off.
public synchronized void	setLogSize(int size in MB megas) Sets the maximum size to which the log file can grow before being automatically checkpointed.
public void	setNioDataFile(boolean value)
public void	setNioMaxSize(int value)
public synchronized void	setScriptType(int The type format) Sets the type of script file, currently 0 for text (default) 3 for compressed
public void	setSqlLogLevel(int level)
private void	setVariables()
public synchronized void	setWriteDelay(int in milliseconds delay) Sets the log write delay mode to number of seconds.
public synchronized void	synchLog()
public synchronized void	writeCommitStatement(Session session) Used at transaction commit
public synchronized void	writeDeleteStatement(Session session, Table t, Object[] row) Used exclusively by PersistentStore objects
public synchronized void	writeInsertStatement(Session session, Row row, Table table) Used exclusively by PersistentStore objects
public synchronized void	writeOtherStatement(Session session, String statement) Records a Log entry for the specified SQL statement, on behalf of the specified Session object.
public synchronized void	writeSequenceStatement(Session session, NumberSequence s) Used at transaction commit

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

Field Detail

appLog	back to summary
public SimpleLog appLog

appLogFileExtension	back to summary
public static final String appLogFileExtension

backup	back to summary
pack-priv DbBackup backup

backupFileExtension	back to summary
public static final String backupFileExtension

backupState	back to summary
pack-priv AtomicInteger backupState

checkpointState	back to summary
pack-priv AtomicInteger checkpointState

cryptLobs	back to summary
pack-priv boolean cryptLobs

crypto	back to summary
private Crypto crypto

database	back to summary
private Database database

dataFileExtension	back to summary
public static final String dataFileExtension

fileAccess	back to summary
public FileAccess fileAccess

fileDateFormat	back to summary
public SimpleDateFormat fileDateFormat

fwLogger	back to summary
pack-priv FrameworkLogger fwLogger

isNewDatabase	back to summary
public boolean isNewDatabase

isSingleFile	back to summary
public boolean isSingleFile

largeDataFactor	back to summary
pack-priv static final int largeDataFactor

lobsFileExtension	back to summary
public static final String lobsFileExtension

lockFile	back to summary
private LockFile lockFile

lockFileExtension	back to summary
public static final String lockFileExtension

log	back to summary
pack-priv Log log

logFileExtension	back to summary
public static final String logFileExtension

loggingEnabled	back to summary
private boolean loggingEnabled

logsStatements	back to summary
private boolean logsStatements

maxLogSize	back to summary
pack-priv long maxLogSize

newFileExtension	back to summary
public static final String newFileExtension

oldFileExtension	back to summary
public static final String oldFileExtension

propCacheMaxRows	back to summary
private int propCacheMaxRows

propCacheMaxSize	back to summary
private long propCacheMaxSize

propCompressLobs	back to summary
pack-priv boolean propCompressLobs

propDataFileDefragLimit	back to summary
pack-priv int propDataFileDefragLimit

propDataFileScale	back to summary
private int propDataFileScale

propDataFileSpace	back to summary
pack-priv int propDataFileSpace

propertiesFileExtension	back to summary
public static final String propertiesFileExtension

propEventLogLevel	back to summary
private int propEventLogLevel

propExternalEventLogLevel	back to summary
private int propExternalEventLogLevel

propFilesTimestamp	back to summary
pack-priv long propFilesTimestamp

propGC	back to summary
pack-priv int propGC

propIsFileDatabase	back to summary
private boolean propIsFileDatabase

propLargeData	back to summary
pack-priv boolean propLargeData

propLobBlockSize	back to summary
pack-priv int propLobBlockSize

propLogData	back to summary
private boolean propLogData

propLogSize	back to summary
private int propLogSize

propMaxFreeBlocks	back to summary
pack-priv int propMaxFreeBlocks

propNioDataFile	back to summary
pack-priv boolean propNioDataFile

propNioMaxSize	back to summary
pack-priv long propNioMaxSize

propRefIntegrity	back to summary
pack-priv boolean propRefIntegrity

propScriptFormat	back to summary
pack-priv int propScriptFormat

propSqlLogLevel	back to summary
pack-priv int propSqlLogLevel

propTextAllowFullPath	back to summary
pack-priv boolean propTextAllowFullPath

propTextSourceDefault	back to summary
pack-priv String propTextSourceDefault

propTxMode	back to summary
pack-priv int propTxMode

propWriteDelay	back to summary
private int propWriteDelay

runtimeFileDelim	back to summary
private static final char runtimeFileDelim

scriptFileExtension	back to summary
public static final String scriptFileExtension

sqlLog	back to summary
public SimpleLog sqlLog

sqlLogFileExtension	back to summary
public static final String sqlLogFileExtension

sqlLogger	back to summary
pack-priv FrameworkLogger sqlLogger

stateBackup	back to summary
pack-priv static final int stateBackup

stateCheckpoint	back to summary
pack-priv static final int stateCheckpoint

stateCheckpointDue	back to summary
pack-priv static final int stateCheckpointDue

stateCheckpointNormal	back to summary
pack-priv static final int stateCheckpointNormal

stateCheckpointRequired	back to summary
pack-priv static final int stateCheckpointRequired

stateNormal	back to summary
pack-priv static final int stateNormal

tempDirectoryPath	back to summary
pack-priv String tempDirectoryPath

textTableManager	back to summary
public TextTableStorageManager textTableManager

Constructor Detail

Logger	back to summary
public Logger(Database database)

Method Detail

acquireLock	back to summary
public void acquireLock(String path)

backup	back to summary
public void backup(String destPath, boolean script, boolean blocking, boolean compressed, boolean files)

backupInternal	back to summary
pack-priv void backupInternal(String destPath, boolean script, boolean blocking, boolean compressed, boolean asFiles)

checkpoint

back to summary

public void checkpoint(Session session, boolean defrag, boolean lobs)

Checkpoints the database.

The most important effect of calling this method is to cause the log file to be rewritten in the most efficient form to reflect the current state of the database, i.e. only the DDL and insert DML required to recreate the database in its present state. Other house-keeping duties are performed w.r.t. other database files, in order to ensure as much as possible the ACID properties of the database.

Exceptions

HsqlException:: if there is a problem checkpointing the database

checkpointInternal	back to summary
private void checkpointInternal(Session session, boolean defrag)

checkPower	back to summary
pack-priv static void checkPower(int n, int max)

back to summary

public boolean close(int closemode)

Shuts down the logging process using the specified mode.

Parameters

closemode:int

The mode in which to shut down the logging process

CLOSEMODE_IMMEDIATELY performs SHUTDOWN IMMEDIATELY, equivalent to a poweroff or crash.
CLOSEMODE_NORMAL performs a normal SHUTDOWN that checkpoints the database normally.
CLOSEMODE_COMPACT 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.
CLOSEMODE_SCRIPT performs a SHUTDOWN SCRIPT.

Returns:boolean

true if closed with no problems or false if a problem was encountered.

getCache	back to summary
public DataFileCache getCache() Returns the Cache object or null if one doesn't exist.

getCacheMaxRows	back to summary
public int getCacheMaxRows()

getCacheSize	back to summary
public long getCacheSize()

getCrypto	back to summary
public Crypto getCrypto()

getDataFileFactor	back to summary
public int getDataFileFactor()

getDataFileScale	back to summary
public int getDataFileScale()

getDataFileSpace	back to summary
public int getDataFileSpace()

getDefragLimit	back to summary
public int getDefragLimit()

getEventLogger

back to summary

private void getEventLogger()

All usage of FrameworkLogger should call this method before using an instance. It ensures and requires that no logging should take place before a new database unique name has been created for a new database or read from the .script file for an old database.

An instance is returned when: - database unique name has been created - FrameworkLogger would use log4j Otherwise null is returned. This tactic avoids usage of file-based jdk logging for the time being.

getFileAccess	back to summary
public FileAccess getFileAccess()

getFilesTimestamp	back to summary
public long getFilesTimestamp()

getLobBlockSize	back to summary
public int getLobBlockSize()

getLobFileScale	back to summary
public int getLobFileScale()

getLogSize	back to summary
public int getLogSize()

getPropertiesSQLArray	back to summary
public List<String> getPropertiesSQLArray(boolean indexRoots)

getPropertyValueMap	back to summary
public HashMap<String, String> getPropertyValueMap()

getSecurePath	back to summary
public String getSecurePath(String path, boolean allowFull, boolean includeRes) Returns a secure path or null for a user-defined path when hsqldb.allow_full_path is false. Returns the path otherwise.

getSqlEventLogLevel	back to summary
public int getSqlEventLogLevel()

getTempDirectoryPath	back to summary
public String getTempDirectoryPath()

getWriteDelay	back to summary
public int getWriteDelay()

hasCache	back to summary
public boolean hasCache() Returns true if Cache object exists.

hasLockFile	back to summary
public boolean hasLockFile()

isAllowedFullPath	back to summary
public boolean isAllowedFullPath()

isCurrentlyLogged	back to summary
public boolean isCurrentlyLogged()

isFileDatabase	back to summary
public boolean isFileDatabase()

isLogged	back to summary
public boolean isLogged()

isNewDatabase	back to summary
public boolean isNewDatabase()

logDetailEvent	back to summary
public void logDetailEvent(String message) Implements org.hsqldb.lib.EventLogInterface.logDetailEvent.

logInfoEvent	back to summary
public void logInfoEvent(String message) Implements org.hsqldb.lib.EventLogInterface.logInfoEvent.

logSevereEvent	back to summary
public void logSevereEvent(String message, Throwable t) Implements org.hsqldb.lib.EventLogInterface.logSevereEvent.

logStatementEvent	back to summary
public void logStatementEvent(Session session, Statement statement, Object[] paramValues, Result result, int level)

logWarningEvent	back to summary
public void logWarningEvent(String message, Throwable t) Implements org.hsqldb.lib.EventLogInterface.logWarningEvent.

needsCheckpointReset	back to summary
public boolean needsCheckpointReset()

newIndex	back to summary
public Index newIndex(HsqlNameManager.HsqlName name, long id, TableBase table, int[] columns, boolean[] descending, boolean[] nullsLast, Type[] colTypes, boolean pk, boolean unique, boolean constraint, boolean forward)

newStore	back to summary
public PersistentStore newStore(Session session, PersistentStoreCollection collection, TableBase table)

newUniqueName	back to summary
pack-priv String newUniqueName()

open

back to summary

public void open()

Opens the specified Database object's database files and starts up the logging process.

If the specified Database object is a new database, its database files are first created.

Exceptions

HsqlException:: if there is a problem, such as the case when the specified files are in use by another process

releaseLock	back to summary
public void releaseLock()

setCacheMaxRows	back to summary
public void setCacheMaxRows(int value)

setCacheSize	back to summary
public void setCacheSize(int value)

setCheckpointRequired	back to summary
public void setCheckpointRequired()

setDataFileScale	back to summary
public void setDataFileScale(int value)

setDataFileScaleNoCheck	back to summary
public void setDataFileScaleNoCheck(int value)

setDataFileSpace	back to summary
public void setDataFileSpace(boolean value)

setDataFileSpace	back to summary
public void setDataFileSpace(int value)

setDefagLimit	back to summary
public void setDefagLimit(int value)

setDefaultTextTableProperties	back to summary
public void setDefaultTextTableProperties(String source, HsqlProperties props)

setEventLogLevel	back to summary
public void setEventLogLevel(int level)

setExternalEventLogLevel	back to summary
public void setExternalEventLogLevel(int level)

setFilesTimestamp	back to summary
public void setFilesTimestamp(long value)

setLobFileCompressed	back to summary
public void setLobFileCompressed(boolean value)

setLobFileCompressedNoCheck	back to summary
public void setLobFileCompressedNoCheck(boolean value)

setLobFileScale	back to summary
public void setLobFileScale(int value)

setLobFileScaleNoCheck	back to summary
public void setLobFileScaleNoCheck(int value)

setLogData	back to summary
public synchronized void setLogData(boolean mode) Sets logging on or off.

setLogSize

back to summary

public synchronized void setLogSize(int megas)

Sets the maximum size to which the log file can grow before being automatically checkpointed.

Parameters

megas:int: size in MB

setNioDataFile	back to summary
public void setNioDataFile(boolean value)

setNioMaxSize	back to summary
public void setNioMaxSize(int value)

setScriptType

back to summary

public synchronized void setScriptType(int format)

Sets the type of script file, currently 0 for text (default) 3 for compressed

Parameters

format:int: The type

setSqlLogLevel	back to summary
public void setSqlLogLevel(int level)

setVariables	back to summary
private void setVariables()

setWriteDelay

back to summary

public synchronized void setWriteDelay(int delay)

Sets the log write delay mode to number of seconds. By default executed commands written to the log are committed fully at most 0.5 second after they are executed. This improves performance for applications that execute a large number of short running statements in a short period of time, but risks failing to log some possibly large number of statements in the event of a crash. A small value improves recovery. A value of 0 will severly slow down logging when autocommit is on, or many short transactions are committed.

Parameters

delay:int: in milliseconds

synchLog	back to summary
public synchronized void synchLog()

writeCommitStatement	back to summary
public synchronized void writeCommitStatement(Session session) Used at transaction commit

writeDeleteStatement	back to summary
public synchronized void writeDeleteStatement(Session session, Table t, Object[] row) Used exclusively by PersistentStore objects

writeInsertStatement	back to summary
public synchronized void writeInsertStatement(Session session, Row row, Table table) Used exclusively by PersistentStore objects

writeOtherStatement	back to summary
public synchronized void writeOtherStatement(Session session, String statement) Records a Log entry for the specified SQL statement, on behalf of the specified Session object.

writeSequenceStatement	back to summary
public synchronized void writeSequenceStatement(Session session, NumberSequence s) Used at transaction commit

public Class Logger

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail