Top Description Fields Constructors Methods
org.hsqldb.scriptio

public Class ScriptWriterText

extends ScriptWriterBase
Class Inheritance
Known Direct Subclasses
org.hsqldb.scriptio.ScriptWriterTextColumnNames, org.hsqldb.scriptio.ScriptWriterEncode
Imports
java.io.IOException, .OutputStream, java.nio.charset.Charset, .StandardCharsets, java.util.zip.GZIPOutputStream, org.hsqldb.Database, .HsqlNameManager.HsqlName, .NumberSequence, .Row, .Session, .Table, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.lib.FileAccess, org.hsqldb.lib.java.JavaSystem, org.hsqldb.rowio.RowOutputInterface, .RowOutputTextLog
Handles all scripting and logging operations. A script consists of two blocks:

DDL: SQL statements for table and user definitions DATA: INSERT statements for memory tables This happens as part of the CHECKPOINT and SHUTDOWN COMPACT process. In this case, the DATA block contains the CACHED table data as well.

A related use for this class is for saving a current snapshot of the database data to a user-defined file with the SCRIPT command A log consists of SQL statements of different types. Each statement is encoded as ASCII and saved.

Author
Fred Toussi (fredt@users dot sourceforge.net)
Since
1.7.2
Version
2.7.3

Field Summary

Modifier and TypeField and Description
pack-priv static byte[]
BYTES_C_ID_INIT

pack-priv static byte[]
BYTES_C_ID_TERM

pack-priv static byte[]
BYTES_COMMIT

pack-priv static byte[]
BYTES_DELETE_FROM

pack-priv static byte[]
BYTES_INSERT_INTO

pack-priv static byte[]
BYTES_LINE_SEP

pack-priv static byte[]
BYTES_SCHEMA

pack-priv static byte[]
BYTES_SEQUENCE

pack-priv static byte[]
BYTES_SEQUENCE_MID

pack-priv static byte[]
BYTES_TERM

pack-priv static byte[]
BYTES_VALUES

pack-priv static byte[]
BYTES_WHERE

pack-priv RowOutputInterface
rowOut

Inherited from org.hsqldb.scriptio.ScriptWriterBase:
byteCountcurrentSessiondatabasefileStreamOutincludeCachedDataincludeIndexRootsincludeTableInitINSERTINSERT_WITH_SCHEMAisClosedisCompressedisCryptisUserScriptlineCountLIST_SCRIPT_FORMATSneedsSyncoutDescriptoroutFileschemaToLogtableRowCountwriteDelay

Constructor Summary

AccessConstructor and Description
public
ScriptWriterText(Database db, OutputStream outputStream, FileAccess.FileSync descriptor, boolean includeCachedData)

public
ScriptWriterText(Database db, String file, boolean includeCachedData, boolean newFile, boolean isUserScript)

public
ScriptWriterText(Database db, String file, boolean includeCachedData, boolean compressed)

Method Summary

Modifier and TypeMethod and Description
protected void
finishStream()

Overrides org.hsqldb.scriptio.ScriptWriterBase.finishStream.

protected void
initBuffers()

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.initBuffers.

public void
writeCommitStatement(Session session)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeCommitStatement.

protected void
writeDataTerm()

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeDataTerm.

public void
writeDeleteStatement(Session session, Table table, Object[] data)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeDeleteStatement.

public void
writeInsertStatement(Session session, Row row, Table table)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeInsertStatement.

public void
writeLogStatement(Session session, String s)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeLogStatement.

public void
writeOtherStatement(Session session, String s)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeOtherStatement.

public void
writeRow(Session session, Row row, Table table)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeRow.

pack-priv void
writeRowOutToFile()

private void
writeSchemaStatement(HsqlNameManager.HsqlName schema)

public void
writeSequenceStatement(Session session, NumberSequence seq)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeSequenceStatement.

protected void
writeSessionIdAndSchema(Session session)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeSessionIdAndSchema.

public void
writeTableInit(Table t)

Overrides org.hsqldb.scriptio.ScriptWriterBase.writeTableInit.

Inherited from org.hsqldb.scriptio.ScriptWriterBase:
closeforceSyncgetWriteDelayopenFilerunsetIncludeCachedDatasetIncludeIndexRootssetIncludeTableInitsetWriteDelaysizestartstopsyncwriteAllwriteDDLwriteExistingDatawriteSingleColumnResultwriteTableDatawriteTableTermwriteTableVersionDatawriteVersioningData

Field Detail

BYTES_C_ID_INITback to summary
pack-priv static byte[] BYTES_C_ID_INIT
BYTES_C_ID_TERMback to summary
pack-priv static byte[] BYTES_C_ID_TERM
BYTES_COMMITback to summary
pack-priv static byte[] BYTES_COMMIT
BYTES_DELETE_FROMback to summary
pack-priv static byte[] BYTES_DELETE_FROM
BYTES_INSERT_INTOback to summary
pack-priv static byte[] BYTES_INSERT_INTO
BYTES_LINE_SEPback to summary
pack-priv static byte[] BYTES_LINE_SEP
BYTES_SCHEMAback to summary
pack-priv static byte[] BYTES_SCHEMA
BYTES_SEQUENCEback to summary
pack-priv static byte[] BYTES_SEQUENCE
BYTES_SEQUENCE_MIDback to summary
pack-priv static byte[] BYTES_SEQUENCE_MID
BYTES_TERMback to summary
pack-priv static byte[] BYTES_TERM
BYTES_VALUESback to summary
pack-priv static byte[] BYTES_VALUES
BYTES_WHEREback to summary
pack-priv static byte[] BYTES_WHERE
rowOutback to summary
pack-priv RowOutputInterface rowOut

Constructor Detail

ScriptWriterTextback to summary
public ScriptWriterText(Database db, OutputStream outputStream, FileAccess.FileSync descriptor, boolean includeCachedData)
ScriptWriterTextback to summary
public ScriptWriterText(Database db, String file, boolean includeCachedData, boolean newFile, boolean isUserScript)
ScriptWriterTextback to summary
public ScriptWriterText(Database db, String file, boolean includeCachedData, boolean compressed)

Method Detail

finishStreamback to summary
protected void finishStream()

Overrides org.hsqldb.scriptio.ScriptWriterBase.finishStream.

initBuffersback to summary
protected void initBuffers()

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.initBuffers.

writeCommitStatementback to summary
public void writeCommitStatement(Session session)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeCommitStatement.

writeDataTermback to summary
protected void writeDataTerm()

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeDataTerm.

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

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeDeleteStatement.

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

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeInsertStatement.

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

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeLogStatement.

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

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeOtherStatement.

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

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeRow.

writeRowOutToFileback to summary
pack-priv void writeRowOutToFile()
writeSchemaStatementback to summary
private void writeSchemaStatement(HsqlNameManager.HsqlName schema)
writeSequenceStatementback to summary
public void writeSequenceStatement(Session session, NumberSequence seq)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeSequenceStatement.

writeSessionIdAndSchemaback to summary
protected void writeSessionIdAndSchema(Session session)

Implements abstract org.hsqldb.scriptio.ScriptWriterBase.writeSessionIdAndSchema.

writeTableInitback to summary
public void writeTableInit(Table t)

Overrides org.hsqldb.scriptio.ScriptWriterBase.writeTableInit.