HyperSQL Database 2.7.4 · org.hsqldb.scriptio.ScriptWriterBase

Handles all logging to file operations. A log consists of three kinds of blocks:

DDL BLOCK: definition of DB objects, users and rights at startup time
DATA BLOCK: all data for MEMORY tables at startup time
LOG BLOCK: SQL statements logged since startup or the last CHECKPOINT
The implementation of this class and its subclasses support the formats used for writing the data. Since 1.7.2 the data can also be written as binary in order to speed up shutdown and startup.

From 1.7.2, two separate files are used, one for the DDL + DATA BLOCK and the other for the LOG BLOCK.

A related use for this class is for saving a current snapshot of the database data to a user-defined file. This happens in the SHUTDOWN COMPACT process or done as a result of the SCRIPT command. In this case, the DATA block contains the CACHED table data as well.

DatabaseScriptReader and its subclasses read back the data at startup time.

Field Summary

Modifier and Type	Field and Description
pack-priv long	byteCount
pack-priv Session	currentSession the last schema for last sessionId
pack-priv Database	database
pack-priv OutputStream	fileStreamOut
pack-priv boolean	includeCachedData
pack-priv boolean	includeIndexRoots
pack-priv boolean	includeTableInit
pack-priv static final int	INSERT
pack-priv static final int	INSERT_WITH_SCHEMA
pack-priv boolean	isClosed
pack-priv boolean	isCompressed
pack-priv boolean	isCrypt
pack-priv boolean	isUserScript this determines if the script is the normal script (false) used internally by the engine or a user-initiated snapshot of the DB (true)
pack-priv long	lineCount
public static final String[]	LIST_SCRIPT_FORMATS
pack-priv volatile boolean	needsSync
pack-priv FileAccess.FileSync	outDescriptor
pack-priv String	outFile
pack-priv HsqlNameManager.HsqlName	schemaToLog
private int	syncCount
pack-priv int	tableRowCount
private Object	timerTask
protected volatile int	writeDelay

Constructor Summary

Access	Constructor and Description
pack-priv	ScriptWriterBase(Database db, OutputStream outputStream, FileAccess.FileSync descriptor, boolean includeCachedData)
pack-priv	ScriptWriterBase(Database db, String file, boolean includeCachedData, boolean isNewFile, boolean isUserScript)

Method Summary

Modifier and Type	Method and Description
public void	close()
protected void	finishStream()
public void	forceSync()
public int	getWriteDelay()
protected abstract void	initBuffers()
protected void	openFile() File is opened in append mode although in current usage the file never pre-exists
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public void	setIncludeCachedData(boolean include)
public void	setIncludeIndexRoots(boolean include)
public void	setIncludeTableInit(boolean include)
public void	setWriteDelay(int delay)
public long	size()
public void	start()
public void	stop()
public void	sync() Called internally or externally in write delay intervals.
public void	writeAll()
public abstract void	writeCommitStatement(Session session)
protected abstract void	writeDataTerm()
public void	writeDDL()
public abstract void	writeDeleteStatement(Session session, Table table, Object[] data)
public void	writeExistingData(boolean lobSchema)
public abstract void	writeInsertStatement(Session session, Row row, Table table)
public abstract void	writeLogStatement(Session session, String s)
public abstract void	writeOtherStatement(Session session, String s)
public abstract void	writeRow(Session session, Row row, Table table)
public abstract void	writeSequenceStatement(Session session, NumberSequence seq)
protected abstract void	writeSessionIdAndSchema(Session session)
protected void	writeSingleColumnResult(Result r)
public void	writeTableData(Table t)
public void	writeTableInit(Table t)
public void	writeTableTerm(Table t)
public void	writeTableVersionData(Table t, TimestampData from)
public void	writeVersioningData(TimestampData from)

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

Field Detail

byteCount	back to summary
pack-priv long byteCount

currentSession	back to summary
pack-priv Session currentSession the last schema for last sessionId

database	back to summary
pack-priv Database database

fileStreamOut	back to summary
pack-priv OutputStream fileStreamOut

includeCachedData	back to summary
pack-priv boolean includeCachedData

includeIndexRoots	back to summary
pack-priv boolean includeIndexRoots

includeTableInit	back to summary
pack-priv boolean includeTableInit

INSERT	back to summary
pack-priv static final int INSERT

INSERT_WITH_SCHEMA	back to summary
pack-priv static final int INSERT_WITH_SCHEMA

isClosed	back to summary
pack-priv boolean isClosed

isCompressed	back to summary
pack-priv boolean isCompressed

isCrypt	back to summary
pack-priv boolean isCrypt

isUserScript	back to summary
pack-priv boolean isUserScript this determines if the script is the normal script (false) used internally by the engine or a user-initiated snapshot of the DB (true)

lineCount	back to summary
pack-priv long lineCount

LIST_SCRIPT_FORMATS	back to summary
public static final String[] LIST_SCRIPT_FORMATS

needsSync	back to summary
pack-priv volatile boolean needsSync

outDescriptor	back to summary
pack-priv FileAccess.FileSync outDescriptor

outFile	back to summary
pack-priv String outFile

schemaToLog	back to summary
pack-priv HsqlNameManager.HsqlName schemaToLog

syncCount	back to summary
private int syncCount

tableRowCount	back to summary
pack-priv int tableRowCount

timerTask	back to summary
private Object timerTask

writeDelay	back to summary
protected volatile int writeDelay

ScriptWriterBase	back to summary
pack-priv ScriptWriterBase(Database db, OutputStream outputStream, FileAccess.FileSync descriptor, boolean includeCachedData)

ScriptWriterBase	back to summary
pack-priv ScriptWriterBase(Database db, String file, boolean includeCachedData, boolean isNewFile, boolean isUserScript)

Method Detail

close	back to summary
public void close()

finishStream	back to summary
protected void finishStream()

forceSync	back to summary
public void forceSync()

getWriteDelay	back to summary
public int getWriteDelay()

initBuffers	back to summary
protected abstract void initBuffers()

openFile	back to summary
protected void openFile() File is opened in append mode although in current usage the file never pre-exists

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation.

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

setIncludeCachedData	back to summary
public void setIncludeCachedData(boolean include)

setIncludeIndexRoots	back to summary
public void setIncludeIndexRoots(boolean include)

setIncludeTableInit	back to summary
public void setIncludeTableInit(boolean include)

setWriteDelay	back to summary
public void setWriteDelay(int delay)

size	back to summary
public long size()

start	back to summary
public void start()

stop	back to summary
public void stop()

sync	back to summary
public void sync() Called internally or externally in write delay intervals.

writeAll	back to summary
public void writeAll()

writeCommitStatement	back to summary
public abstract void writeCommitStatement(Session session)

writeDataTerm	back to summary
protected abstract void writeDataTerm()

writeDDL	back to summary
public void writeDDL()

writeDeleteStatement	back to summary
public abstract void writeDeleteStatement(Session session, Table table, Object[] data)

writeExistingData	back to summary
public void writeExistingData(boolean lobSchema)

writeInsertStatement	back to summary
public abstract void writeInsertStatement(Session session, Row row, Table table)

writeLogStatement	back to summary
public abstract void writeLogStatement(Session session, String s)

writeOtherStatement	back to summary
public abstract void writeOtherStatement(Session session, String s)

writeRow	back to summary
public abstract void writeRow(Session session, Row row, Table table)

writeSequenceStatement	back to summary
public abstract void writeSequenceStatement(Session session, NumberSequence seq)

writeSessionIdAndSchema	back to summary
protected abstract void writeSessionIdAndSchema(Session session)

writeSingleColumnResult	back to summary
protected void writeSingleColumnResult(Result r)

writeTableData	back to summary
public void writeTableData(Table t)

writeTableInit	back to summary
public void writeTableInit(Table t)

writeTableTerm	back to summary
public void writeTableTerm(Table t)

writeTableVersionData	back to summary
public void writeTableVersionData(Table t, TimestampData from)

writeVersioningData	back to summary
public void writeVersioningData(TimestampData from)

public abstract Class ScriptWriterBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail