org.h2.command.dml
Class ScriptBase

java.lang.Object
  extended by org.h2.command.Prepared
      extended by org.h2.command.dml.ScriptBase
All Implemented Interfaces:
DataHandler
Direct Known Subclasses:
RunScriptCommand, ScriptCommand

public abstract class ScriptBase
extends Prepared
implements DataHandler

This class is the base for RunScriptCommand and ScriptCommand.


Field Summary
protected  java.io.InputStream in
          The input stream.
protected  java.io.OutputStream out
          The output stream.
 
Fields inherited from class org.h2.command.Prepared
create, parameters, prepareAlways, session, sqlStatement
 
Constructor Summary
ScriptBase(Session session)
           
 
Method Summary
 void checkPowerOff()
          Check if the simulated power failure occurred.
 void checkWritingAllowed()
          Check if writing is allowed.
 void freeUpDiskSpace()
          Free up disk space if possible.
 java.lang.String getDatabasePath()
          Get the database path.
protected  java.lang.String getFileName()
           
 java.lang.String getLobCompressionAlgorithm(int type)
          Get the compression algorithm used for large objects.
 java.sql.Connection getLobConnection()
          Get a database connection to be used for LOB access.
 SmallLRUCache<java.lang.String,java.lang.String[]> getLobFileListCache()
          Get the lob file list cache if it is used.
 LobStorage getLobStorage()
          Get the lob storage mechanism to use.
 java.lang.Object getLobSyncObject()
          Get the synchronization object for lob operations.
 int getMaxLengthInplaceLob()
          Get the maximum length of a in-place large object
 TempFileDeleter getTempFileDeleter()
          Get the temp file deleter mechanism.
 boolean isTransactional()
          Check if this command is transactional.
 boolean needRecompile()
          Check if the statement needs to be re-compiled.
 FileStore openFile(java.lang.String name, java.lang.String mode, boolean mustExist)
          Open a file at the given location.
 void setCipher(java.lang.String c)
           
 void setCompressionAlgorithm(java.lang.String algorithm)
           
 void setFileNameExpr(Expression file)
           
 void setPassword(char[] password)
           
 
Methods inherited from class org.h2.command.Prepared
checkCanceled, checkParameters, getCurrentObjectId, getCurrentRowNumber, getObjectId, getParameters, getPlanSQL, getSQL, getSQL, getSQL, getType, isCacheable, isQuery, isReadOnly, prepare, query, queryMeta, setCommand, setCurrentRowNumber, setObjectId, setParameterList, setPrepareAlways, setRow, setSession, setSQL, toString, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

out

protected java.io.OutputStream out
The output stream.


in

protected java.io.InputStream in
The input stream.

Constructor Detail

ScriptBase

public ScriptBase(Session session)
Method Detail

setCipher

public void setCipher(java.lang.String c)

setPassword

public void setPassword(char[] password)

setFileNameExpr

public void setFileNameExpr(Expression file)

getFileName

protected java.lang.String getFileName()

isTransactional

public boolean isTransactional()
Description copied from class: Prepared
Check if this command is transactional. If it is not, then it forces the current transaction to commit.

Specified by:
isTransactional in class Prepared
Returns:
true if it is

needRecompile

public boolean needRecompile()
Description copied from class: Prepared
Check if the statement needs to be re-compiled.

Overrides:
needRecompile in class Prepared
Returns:
true if it must

getDatabasePath

public java.lang.String getDatabasePath()
Description copied from interface: DataHandler
Get the database path.

Specified by:
getDatabasePath in interface DataHandler
Returns:
the database path

openFile

public FileStore openFile(java.lang.String name,
                          java.lang.String mode,
                          boolean mustExist)
Description copied from interface: DataHandler
Open a file at the given location.

Specified by:
openFile in interface DataHandler
Parameters:
name - the file name
mode - the mode
mustExist - whether the file must already exist
Returns:
the file

checkPowerOff

public void checkPowerOff()
Description copied from interface: DataHandler
Check if the simulated power failure occurred. This call will decrement the countdown.

Specified by:
checkPowerOff in interface DataHandler

checkWritingAllowed

public void checkWritingAllowed()
Description copied from interface: DataHandler
Check if writing is allowed.

Specified by:
checkWritingAllowed in interface DataHandler

freeUpDiskSpace

public void freeUpDiskSpace()
Description copied from interface: DataHandler
Free up disk space if possible. This method is called if more space is needed.

Specified by:
freeUpDiskSpace in interface DataHandler

getMaxLengthInplaceLob

public int getMaxLengthInplaceLob()
Description copied from interface: DataHandler
Get the maximum length of a in-place large object

Specified by:
getMaxLengthInplaceLob in interface DataHandler
Returns:
the maximum size

getTempFileDeleter

public TempFileDeleter getTempFileDeleter()
Description copied from interface: DataHandler
Get the temp file deleter mechanism.

Specified by:
getTempFileDeleter in interface DataHandler
Returns:
the temp file deleter

getLobCompressionAlgorithm

public java.lang.String getLobCompressionAlgorithm(int type)
Description copied from interface: DataHandler
Get the compression algorithm used for large objects.

Specified by:
getLobCompressionAlgorithm in interface DataHandler
Parameters:
type - the data type (CLOB or BLOB)
Returns:
the compression algorithm, or null

setCompressionAlgorithm

public void setCompressionAlgorithm(java.lang.String algorithm)

getLobSyncObject

public java.lang.Object getLobSyncObject()
Description copied from interface: DataHandler
Get the synchronization object for lob operations.

Specified by:
getLobSyncObject in interface DataHandler
Returns:
the synchronization object

getLobFileListCache

public SmallLRUCache<java.lang.String,java.lang.String[]> getLobFileListCache()
Description copied from interface: DataHandler
Get the lob file list cache if it is used.

Specified by:
getLobFileListCache in interface DataHandler
Returns:
the cache or null

getLobStorage

public LobStorage getLobStorage()
Description copied from interface: DataHandler
Get the lob storage mechanism to use.

Specified by:
getLobStorage in interface DataHandler
Returns:
the lob storage mechanism

getLobConnection

public java.sql.Connection getLobConnection()
Description copied from interface: DataHandler
Get a database connection to be used for LOB access.

Specified by:
getLobConnection in interface DataHandler
Returns:
the connection or null