ScriptCommand (H2 Database Engine wt-1.0.1 API)

java.lang.Object
- org.h2.command.Prepared
- - org.h2.command.dml.ScriptCommand

所有已实现的接口:

DataHandler
```
public class ScriptCommand
extends Prepared
```
This class represents the statement SCRIPT

字段概要

字段
限定符和类型字段和说明

protected InputStream in
The input stream.

protected OutputStream out
The output stream.
- 从类继承的字段 org.h2.command.Prepared
  create, parameters, prepareAlways, session, sqlStatement

字段
限定符和类型	字段和说明
`protected InputStream`	`in` The input stream.
`protected OutputStream`	`out` The output stream.

构造器概要

构造器
构造器和说明

ScriptCommand(Session session)

构造器
构造器和说明
`ScriptCommand(Session session)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`checkPowerOff()` Check if the simulated power failure occurred.
`void`	`checkWritingAllowed()` Check if writing is allowed.
`static InputStream`	`combineBlob(Connection conn, int id)` Combine a BLOB.
`static Reader`	`combineClob(Connection conn, int id)` Combine a CLOB.
`CompareMode`	`getCompareMode()` Return compare mode.
`String`	`getDatabasePath()` Get the database path.
`protected String`	`getFileName()`
`JavaObjectSerializer`	`getJavaObjectSerializer()` Return the serializer to be used for java objects being stored in column of type OTHER.
`String`	`getLobCompressionAlgorithm(int type)` Get the compression algorithm used for large objects.
`SmallLRUCache<String,String[]>`	`getLobFileListCache()` Get the lob file list cache if it is used.
`LobStorageBackend`	`getLobStorage()` Get the lob storage mechanism to use.
`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.
`int`	`getType()` Get the command type as defined in CommandInterface
`boolean`	`isQuery()` Check if this object is a query.
`boolean`	`isTransactional()` Check if this command is transactional.
`boolean`	`needRecompile()` Check if the statement needs to be re-compiled.
`FileStore`	`openFile(String name, String mode, boolean mustExist)` Open a file at the given location.
`ResultInterface`	`query(int maxrows)` Execute the query.
`ResultInterface`	`queryMeta()` Get an empty result set containing the meta data.
`int`	`readLob(long lobId, byte[] hmac, long offset, byte[] buff, int off, int length)` Read from a lob.
`void`	`setCharset(Charset charset)`
`void`	`setCipher(String c)`
`void`	`setCompressionAlgorithm(String algorithm)`
`void`	`setData(boolean data)`
`void`	`setDrop(boolean drop)`
`void`	`setFileNameExpr(Expression file)`
`void`	`setLobBlockSize(long blockSize)`
`void`	`setPassword(Expression password)`
`void`	`setPasswords(boolean passwords)`
`void`	`setSchemaNames(Set<String> schemaNames)`
`void`	`setSettings(boolean settings)`
`void`	`setSimple(boolean simple)`
`void`	`setTables(Collection<Table> tables)`

从类继承的方法 org.h2.command.Prepared
checkCanceled, checkParameters, getCurrentObjectId, getCurrentRowNumber, getObjectId, getParameters, getPlanSQL, getSQL, getSQL, getSQL, isCacheable, isReadOnly, prepare, setCommand, setCurrentRowNumber, setObjectId, setParameterList, setPrepareAlways, setRow, setSession, setSQL, toString, update

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - out
```
protected OutputStream out
```
    The output stream.
  - in
```
protected InputStream in
```
    The input stream.
- 构造器详细资料
  - ScriptCommand
```
public ScriptCommand(Session session)
```
- 方法详细资料
  - isQuery
```
public boolean isQuery()
```
    从类复制的说明: Prepared
    
    Check if this object is a query.
    
    覆盖:
    
    isQuery 在类中 Prepared
    
    返回:
    
    true if it is
  - setSchemaNames
```
public void setSchemaNames(Set<String> schemaNames)
```
  - setTables
```
public void setTables(Collection<Table> tables)
```
  - setData
```
public void setData(boolean data)
```
  - setPasswords
```
public void setPasswords(boolean passwords)
```
  - setSettings
```
public void setSettings(boolean settings)
```
  - setLobBlockSize
```
public void setLobBlockSize(long blockSize)
```
  - setDrop
```
public void setDrop(boolean drop)
```
  - queryMeta
```
public ResultInterface queryMeta()
```
    从类复制的说明: Prepared
    
    Get an empty result set containing the meta data.
    
    指定者:
    
    queryMeta 在类中 Prepared
    
    返回:
    
    the result set
  - query
```
public ResultInterface query(int maxrows)
```
    从类复制的说明: Prepared
    
    Execute the query.
    
    覆盖:
    
    query 在类中 Prepared
    
    参数:
    
    maxrows - the maximum number of rows to return
    
    返回:
    
    the result set
  - combineBlob
```
public static InputStream combineBlob(Connection conn,
                                      int id)
                               throws SQLException
```
    Combine a BLOB. This method is called from the script. When calling with id -1, the file is deleted.
    
    参数:
    
    conn - a connection
    
    id - the lob id
    
    返回:
    
    a stream for the combined data
    
    抛出:
    
    SQLException
  - combineClob
```
public static Reader combineClob(Connection conn,
                                 int id)
                          throws SQLException
```
    Combine a CLOB. This method is called from the script.
    
    参数:
    
    conn - a connection
    
    id - the lob id
    
    返回:
    
    a reader for the combined data
    
    抛出:
    
    SQLException
  - setSimple
```
public void setSimple(boolean simple)
```
  - setCharset
```
public void setCharset(Charset charset)
```
  - getType
```
public int getType()
```
    从类复制的说明: Prepared
    
    Get the command type as defined in CommandInterface
    
    指定者:
    
    getType 在类中 Prepared
    
    返回:
    
    the statement type
  - setCipher
```
public void setCipher(String c)
```
  - setPassword
```
public void setPassword(Expression password)
```
  - setFileNameExpr
```
public void setFileNameExpr(Expression file)
```
  - getFileName
```
protected String getFileName()
```
  - isTransactional
```
public boolean isTransactional()
```
    从类复制的说明: Prepared
    
    Check if this command is transactional. If it is not, then it forces the current transaction to commit.
    
    指定者:
    
    isTransactional 在类中 Prepared
    
    返回:
    
    true if it is
  - needRecompile
```
public boolean needRecompile()
```
    从类复制的说明: Prepared
    
    Check if the statement needs to be re-compiled.
    
    覆盖:
    
    needRecompile 在类中 Prepared
    
    返回:
    
    true if it must
  - getDatabasePath
```
public String getDatabasePath()
```
    从接口复制的说明: DataHandler
    
    Get the database path.
    
    指定者:
    
    getDatabasePath 在接口中 DataHandler
    
    返回:
    
    the database path
  - openFile
```
public FileStore openFile(String name,
                          String mode,
                          boolean mustExist)
```
    从接口复制的说明: DataHandler
    
    Open a file at the given location.
    
    指定者:
    
    openFile 在接口中 DataHandler
    
    参数:
    
    name - the file name
    
    mode - the mode
    
    mustExist - whether the file must already exist
    
    返回:
    
    the file
  - checkPowerOff
```
public void checkPowerOff()
```
    从接口复制的说明: DataHandler
    
    Check if the simulated power failure occurred. This call will decrement the countdown.
    
    指定者:
    
    checkPowerOff 在接口中 DataHandler
  - checkWritingAllowed
```
public void checkWritingAllowed()
```
    从接口复制的说明: DataHandler
    
    Check if writing is allowed.
    
    指定者:
    
    checkWritingAllowed 在接口中 DataHandler
  - getMaxLengthInplaceLob
```
public int getMaxLengthInplaceLob()
```
    从接口复制的说明: DataHandler
    
    Get the maximum length of a in-place large object
    
    指定者:
    
    getMaxLengthInplaceLob 在接口中 DataHandler
    
    返回:
    
    the maximum size
  - getTempFileDeleter
```
public TempFileDeleter getTempFileDeleter()
```
    从接口复制的说明: DataHandler
    
    Get the temp file deleter mechanism.
    
    指定者:
    
    getTempFileDeleter 在接口中 DataHandler
    
    返回:
    
    the temp file deleter
  - getLobCompressionAlgorithm
```
public String getLobCompressionAlgorithm(int type)
```
    从接口复制的说明: DataHandler
    
    Get the compression algorithm used for large objects.
    
    指定者:
    
    getLobCompressionAlgorithm 在接口中 DataHandler
    
    参数:
    
    type - the data type (CLOB or BLOB)
    
    返回:
    
    the compression algorithm, or null
  - setCompressionAlgorithm
```
public void setCompressionAlgorithm(String algorithm)
```
  - getLobSyncObject
```
public Object getLobSyncObject()
```
    从接口复制的说明: DataHandler
    
    Get the synchronization object for lob operations.
    
    指定者:
    
    getLobSyncObject 在接口中 DataHandler
    
    返回:
    
    the synchronization object
  - getLobFileListCache
```
public SmallLRUCache<String,String[]> getLobFileListCache()
```
    从接口复制的说明: DataHandler
    
    Get the lob file list cache if it is used.
    
    指定者:
    
    getLobFileListCache 在接口中 DataHandler
    
    返回:
    
    the cache or null
  - getLobStorage
```
public LobStorageBackend getLobStorage()
```
    从接口复制的说明: DataHandler
    
    Get the lob storage mechanism to use.
    
    指定者:
    
    getLobStorage 在接口中 DataHandler
    
    返回:
    
    the lob storage mechanism
  - readLob
```
public int readLob(long lobId,
                   byte[] hmac,
                   long offset,
                   byte[] buff,
                   int off,
                   int length)
```
    从接口复制的说明: DataHandler
    
    Read from a lob.
    
    指定者:
    
    readLob 在接口中 DataHandler
    
    参数:
    
    lobId - the lob id
    
    hmac - the message authentication code
    
    offset - the offset within the lob
    
    buff - the target buffer
    
    off - the offset within the target buffer
    
    length - the number of bytes to read
    
    返回:
    
    the number of bytes read
  - getJavaObjectSerializer
```
public JavaObjectSerializer getJavaObjectSerializer()
```
    从接口复制的说明: DataHandler
    
    Return the serializer to be used for java objects being stored in column of type OTHER.
    
    指定者:
    
    getJavaObjectSerializer 在接口中 DataHandler
    
    返回:
    
    the serializer to be used for java objects being stored in column of type OTHER
  - getCompareMode
```
public CompareMode getCompareMode()
```
    从接口复制的说明: DataHandler
    
    Return compare mode.
    
    指定者:
    
    getCompareMode 在接口中 DataHandler
    
    返回:
    
    Compare mode.

类 ScriptCommand

字段概要

从类继承的字段 org.h2.command.Prepared

构造器概要

方法概要

从类继承的方法 org.h2.command.Prepared

从类继承的方法 java.lang.Object

字段详细资料

out

in

构造器详细资料

ScriptCommand

方法详细资料

isQuery

setSchemaNames

setTables

setData

setPasswords

setSettings

setLobBlockSize

setDrop

queryMeta

query

combineBlob

combineClob

setSimple

setCharset

getType

setCipher

setPassword

setFileNameExpr

getFileName

isTransactional

needRecompile

getDatabasePath

openFile

checkPowerOff

checkWritingAllowed

getMaxLengthInplaceLob

getTempFileDeleter

getLobCompressionAlgorithm

setCompressionAlgorithm

getLobSyncObject

getLobFileListCache

getLobStorage

readLob

getJavaObjectSerializer

getCompareMode