SessionRemote (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.engine.Session
- - org.h2.engine.SessionRemote

所有已实现的接口:

AutoCloseable, CastDataProvider, DataHandler
```
public final class SessionRemote
extends Session
implements DataHandler
```
The client side part of a session when using the server mode. This object communicates with a Session on the server side.

嵌套类概要
- 从类继承的嵌套类/接口 org.h2.engine.Session
  Session.DynamicSettings, Session.StaticSettings

字段概要

字段
限定符和类型	字段和说明
`static int`	`CHANGE_ID`
`static int`	`COMMAND_CLOSE`
`static int`	`COMMAND_COMMIT`
`static int`	`COMMAND_EXECUTE_QUERY`
`static int`	`COMMAND_EXECUTE_UPDATE`
`static int`	`COMMAND_GET_META_DATA`
`static int`	`GET_JDBC_META`
`static int`	`LOB_READ`
`static int`	`RESULT_CLOSE`
`static int`	`RESULT_FETCH_ROWS`
`static int`	`RESULT_RESET`
`static int`	`SESSION_CANCEL_STATEMENT`
`static int`	`SESSION_CHECK_KEY`
`static int`	`SESSION_CLOSE`
`static int`	`SESSION_HAS_PENDING_TRANSACTION`
`static int`	`SESSION_PREPARE`
`static int`	`SESSION_PREPARE_READ_PARAMS2`
`static int`	`SESSION_SET_AUTOCOMMIT`
`static int`	`SESSION_SET_ID`
`static int`	`STATUS_CLOSED`
`static int`	`STATUS_ERROR`
`static int`	`STATUS_OK`
`static int`	`STATUS_OK_STATE_CHANGED`

构造器概要

构造器
构造器和说明

SessionRemote(ConnectionInfo ci)

构造器
构造器和说明
`SessionRemote(ConnectionInfo ci)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ValueLob`	`addTemporaryLob(ValueLob v)` Add a temporary LOB, which is closed when the session commits.
`void`	`autoCommitIfCluster()` Calls COMMIT if the session is in cluster mode.
`void`	`cancel()` Cancel the current or next command (called when closing a connection).
`void`	`cancelStatement(int id)` Cancel the statement with the given id.
`void`	`checkClosed()` Check if this session is closed and throws an exception if so.
`void`	`checkPowerOff()` Check if the simulated power failure occurred.
`void`	`checkWritingAllowed()` Check if writing is allowed.
`void`	`close()` Roll back pending transactions and close the session.
`Session`	`connectEmbeddedOrServer(boolean openNew)` Open a new (remote or embedded) session.
`ValueTimestampTimeZone`	`currentTimestamp()` Returns the current timestamp with maximum resolution.
`TimeZoneProvider`	`currentTimeZone()` Returns the current time zone.
`void`	`done(Transfer transfer)` Called to flush the output after data has been sent to the server and just before receiving data.
`boolean`	`getAutoCommit()` Check if this session is in auto-commit mode.
`int`	`getClientVersion()` Returns the TCP protocol version of remote connection.
`ArrayList<String>`	`getClusterServers()` Get the list of the cluster servers for this session.
`CompareMode`	`getCompareMode()` Return compare mode.
`int`	`getCurrentId()`
`String`	`getCurrentSchemaName()` Get current schema.
`DatabaseMeta`	`getDatabaseMeta()` Returns database meta information.
`String`	`getDatabasePath()` Get the database path.
`DataHandler`	`getDataHandler()` Get the data handler object.
`Session.DynamicSettings`	`getDynamicSettings()` Returns dynamic settings.
`IsolationLevel`	`getIsolationLevel()` Returns the isolation level.
`JavaObjectSerializer`	`getJavaObjectSerializer()` Returns the custom Java object serializer, or `null`.
`int`	`getLastReconnect()`
`SmallLRUCache<String,String[]>`	`getLobFileListCache()` Get the lob file list cache if it is used.
`LobStorageFrontend`	`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
`Mode`	`getMode()` Returns the database mode.
`int`	`getNextId()`
`Session.StaticSettings`	`getStaticSettings()` Returns static settings.
`TempFileDeleter`	`getTempFileDeleter()` Get the temp file deleter mechanism.
`Trace`	`getTrace()` Get the trace object
`boolean`	`hasPendingTransaction()` Check whether this session has a pending transaction.
`boolean`	`isClosed()` Check if close was called.
`boolean`	`isClustered()` Returns true if the connection was opened in cluster mode.
`boolean`	`isOldInformationSchema()` Returns whether INFORMATION_SCHEMA contains old-style tables.
`boolean`	`isRemote()` Check if this session is remote or embedded.
`FileStore`	`openFile(String name, String mode, boolean mustExist)` Open a file at the given location.
`CommandInterface`	`prepareCommand(String sql, int fetchSize)` Parse a command and prepare it for execution.
`static DbException`	`readException(Transfer transfer)` Reads an exception.
`int`	`readLob(long lobId, byte[] hmac, long offset, byte[] buff, int off, int length)` Read from a lob.
`void`	`removeServer(IOException e, int i, int count)` Remove a server from the list of cluster nodes and disables the cluster mode.
`void`	`setAutoCommit(boolean autoCommit)` Set the auto-commit mode.
`void`	`setAutoCommitFromServer(boolean autoCommit)`
`void`	`setCurrentSchemaName(String schema)` Set current schema.
`void`	`setIsolationLevel(IsolationLevel isolationLevel)` Sets the isolation level.
`void`	`setNetworkConnectionInfo(NetworkConnectionInfo networkConnectionInfo)` Sets the network connection information if possible.
`void`	`traceOperation(String operation, int id)` Write the operation to the trace system if debug trace is enabled.
`boolean`	`zeroBasedEnums()` Returns are ENUM values 0-based.

从类继承的方法 org.h2.engine.Session
readSessionState, resetThreadLocalSession, setThreadLocalSession

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

- 字段详细资料
  - SESSION_PREPARE
```
public static final int SESSION_PREPARE
```
    另请参阅:
    
    常量字段值
  - SESSION_CLOSE
```
public static final int SESSION_CLOSE
```
    另请参阅:
    
    常量字段值
  - COMMAND_EXECUTE_QUERY
```
public static final int COMMAND_EXECUTE_QUERY
```
    另请参阅:
    
    常量字段值
  - COMMAND_EXECUTE_UPDATE
```
public static final int COMMAND_EXECUTE_UPDATE
```
    另请参阅:
    
    常量字段值
  - COMMAND_CLOSE
```
public static final int COMMAND_CLOSE
```
    另请参阅:
    
    常量字段值
  - RESULT_FETCH_ROWS
```
public static final int RESULT_FETCH_ROWS
```
    另请参阅:
    
    常量字段值
  - RESULT_RESET
```
public static final int RESULT_RESET
```
    另请参阅:
    
    常量字段值
  - RESULT_CLOSE
```
public static final int RESULT_CLOSE
```
    另请参阅:
    
    常量字段值
  - COMMAND_COMMIT
```
public static final int COMMAND_COMMIT
```
    另请参阅:
    
    常量字段值
  - CHANGE_ID
```
public static final int CHANGE_ID
```
    另请参阅:
    
    常量字段值
  - COMMAND_GET_META_DATA
```
public static final int COMMAND_GET_META_DATA
```
    另请参阅:
    
    常量字段值
  - SESSION_SET_ID
```
public static final int SESSION_SET_ID
```
    另请参阅:
    
    常量字段值
  - SESSION_CANCEL_STATEMENT
```
public static final int SESSION_CANCEL_STATEMENT
```
    另请参阅:
    
    常量字段值
  - SESSION_CHECK_KEY
```
public static final int SESSION_CHECK_KEY
```
    另请参阅:
    
    常量字段值
  - SESSION_SET_AUTOCOMMIT
```
public static final int SESSION_SET_AUTOCOMMIT
```
    另请参阅:
    
    常量字段值
  - SESSION_HAS_PENDING_TRANSACTION
```
public static final int SESSION_HAS_PENDING_TRANSACTION
```
    另请参阅:
    
    常量字段值
  - LOB_READ
```
public static final int LOB_READ
```
    另请参阅:
    
    常量字段值
  - SESSION_PREPARE_READ_PARAMS2
```
public static final int SESSION_PREPARE_READ_PARAMS2
```
    另请参阅:
    
    常量字段值
  - GET_JDBC_META
```
public static final int GET_JDBC_META
```
    另请参阅:
    
    常量字段值
  - STATUS_ERROR
```
public static final int STATUS_ERROR
```
    另请参阅:
    
    常量字段值
  - STATUS_OK
```
public static final int STATUS_OK
```
    另请参阅:
    
    常量字段值
  - STATUS_CLOSED
```
public static final int STATUS_CLOSED
```
    另请参阅:
    
    常量字段值
  - STATUS_OK_STATE_CHANGED
```
public static final int STATUS_OK_STATE_CHANGED
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - SessionRemote
```
public SessionRemote(ConnectionInfo ci)
```
- 方法详细资料
  - getClusterServers
```
public ArrayList<String> getClusterServers()
```
    从类复制的说明: Session
    
    Get the list of the cluster servers for this session.
    
    指定者:
    
    getClusterServers 在类中 Session
    
    返回:
    
    A list of "ip:port" strings for the cluster servers in this session.
  - hasPendingTransaction
```
public boolean hasPendingTransaction()
```
    从类复制的说明: Session
    
    Check whether this session has a pending transaction.
    
    指定者:
    
    hasPendingTransaction 在类中 Session
    
    返回:
    
    true if it has
  - cancel
```
public void cancel()
```
    从类复制的说明: Session
    
    Cancel the current or next command (called when closing a connection).
    
    指定者:
    
    cancel 在类中 Session
  - cancelStatement
```
public void cancelStatement(int id)
```
    Cancel the statement with the given id.
    
    参数:
    
    id - the statement id
  - getClientVersion
```
public int getClientVersion()
```
    Returns the TCP protocol version of remote connection.
    
    返回:
    
    the TCP protocol version
  - getAutoCommit
```
public boolean getAutoCommit()
```
    从类复制的说明: Session
    
    Check if this session is in auto-commit mode.
    
    指定者:
    
    getAutoCommit 在类中 Session
    
    返回:
    
    true if the session is in auto-commit mode
  - setAutoCommit
```
public void setAutoCommit(boolean autoCommit)
```
    从类复制的说明: Session
    
    Set the auto-commit mode. This call doesn't commit the current transaction.
    
    指定者:
    
    setAutoCommit 在类中 Session
    
    参数:
    
    autoCommit - the new value
  - setAutoCommitFromServer
```
public void setAutoCommitFromServer(boolean autoCommit)
```
  - autoCommitIfCluster
```
public void autoCommitIfCluster()
```
    Calls COMMIT if the session is in cluster mode.
  - connectEmbeddedOrServer
```
public Session connectEmbeddedOrServer(boolean openNew)
```
    Open a new (remote or embedded) session.
    
    参数:
    
    openNew - whether to open a new session in any case
    
    返回:
    
    the session
  - removeServer
```
public void removeServer(IOException e,
                         int i,
                         int count)
```
    Remove a server from the list of cluster nodes and disables the cluster mode.
    
    参数:
    
    e - the exception (used for debugging)
    
    i - the index of the server to remove
    
    count - the retry count index
  - prepareCommand
```
public CommandInterface prepareCommand(String sql,
                                       int fetchSize)
```
    从类复制的说明: Session
    
    Parse a command and prepare it for execution.
    
    指定者:
    
    prepareCommand 在类中 Session
    
    参数:
    
    sql - the SQL statement
    
    fetchSize - the number of rows to fetch in one step
    
    返回:
    
    the prepared command
  - checkClosed
```
public void checkClosed()
```
    Check if this session is closed and throws an exception if so.
    
    抛出:
    
    DbException - if the session is closed
  - close
```
public void close()
```
    从类复制的说明: Session
    
    Roll back pending transactions and close the session.
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在类中 Session
  - getTrace
```
public Trace getTrace()
```
    从类复制的说明: Session
    
    Get the trace object
    
    指定者:
    
    getTrace 在类中 Session
    
    返回:
    
    the trace object
  - getNextId
```
public int getNextId()
```
  - getCurrentId
```
public int getCurrentId()
```
  - done
```
public void done(Transfer transfer)
          throws IOException
```
    Called to flush the output after data has been sent to the server and just before receiving data. This method also reads the status code from the server and throws any exception the server sent.
    
    参数:
    
    transfer - the transfer object
    
    抛出:
    
    DbException - if the server sent an exception
    
    IOException - if there is a communication problem between client and server
  - readException
```
public static DbException readException(Transfer transfer)
                                 throws IOException
```
    Reads an exception.
    
    参数:
    
    transfer - the transfer object
    
    返回:
    
    the exception
    
    抛出:
    
    IOException - on I/O exception
  - isClustered
```
public boolean isClustered()
```
    Returns true if the connection was opened in cluster mode.
    
    返回:
    
    true if it is
  - isClosed
```
public boolean isClosed()
```
    从类复制的说明: Session
    
    Check if close was called.
    
    指定者:
    
    isClosed 在类中 Session
    
    返回:
    
    if the session has been closed
  - traceOperation
```
public void traceOperation(String operation,
                           int id)
```
    Write the operation to the trace system if debug trace is enabled.
    
    参数:
    
    operation - the operation performed
    
    id - the id of the operation
  - 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
  - getDatabasePath
```
public String getDatabasePath()
```
    从接口复制的说明: DataHandler
    
    Get the database path.
    
    指定者:
    
    getDatabasePath 在接口中 DataHandler
    
    返回:
    
    the database path
  - getMaxLengthInplaceLob
```
public int getMaxLengthInplaceLob()
```
    从接口复制的说明: DataHandler
    
    Get the maximum length of a in-place large object
    
    指定者:
    
    getMaxLengthInplaceLob 在接口中 DataHandler
    
    返回:
    
    the maximum size
  - 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
  - getDataHandler
```
public DataHandler getDataHandler()
```
    从类复制的说明: Session
    
    Get the data handler object.
    
    指定者:
    
    getDataHandler 在类中 Session
    
    返回:
    
    the data handler
  - 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
  - getLastReconnect
```
public int getLastReconnect()
```
  - getTempFileDeleter
```
public TempFileDeleter getTempFileDeleter()
```
    从接口复制的说明: DataHandler
    
    Get the temp file deleter mechanism.
    
    指定者:
    
    getTempFileDeleter 在接口中 DataHandler
    
    返回:
    
    the temp file deleter
  - getLobStorage
```
public LobStorageFrontend 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()
```
    从接口复制的说明: CastDataProvider
    
    Returns the custom Java object serializer, or null.
    
    指定者:
    
    getJavaObjectSerializer 在接口中 CastDataProvider
    
    返回:
    
    the custom Java object serializer, or null
  - addTemporaryLob
```
public ValueLob addTemporaryLob(ValueLob v)
```
    从类复制的说明: Session
    
    Add a temporary LOB, which is closed when the session commits.
    
    指定者:
    
    addTemporaryLob 在类中 Session
    
    参数:
    
    v - the value
    
    返回:
    
    the specified value
  - getCompareMode
```
public CompareMode getCompareMode()
```
    从接口复制的说明: DataHandler
    
    Return compare mode.
    
    指定者:
    
    getCompareMode 在接口中 DataHandler
    
    返回:
    
    Compare mode.
  - isRemote
```
public boolean isRemote()
```
    从类复制的说明: Session
    
    Check if this session is remote or embedded.
    
    指定者:
    
    isRemote 在类中 Session
    
    返回:
    
    true if this session is remote
  - getCurrentSchemaName
```
public String getCurrentSchemaName()
```
    从类复制的说明: Session
    
    Get current schema.
    
    指定者:
    
    getCurrentSchemaName 在类中 Session
    
    返回:
    
    the current schema name
  - setCurrentSchemaName
```
public void setCurrentSchemaName(String schema)
```
    从类复制的说明: Session
    
    Set current schema.
    
    指定者:
    
    setCurrentSchemaName 在类中 Session
    
    参数:
    
    schema - the schema name
  - setNetworkConnectionInfo
```
public void setNetworkConnectionInfo(NetworkConnectionInfo networkConnectionInfo)
```
    从类复制的说明: Session
    
    Sets the network connection information if possible.
    
    指定者:
    
    setNetworkConnectionInfo 在类中 Session
    
    参数:
    
    networkConnectionInfo - the network connection information
  - getIsolationLevel
```
public IsolationLevel getIsolationLevel()
```
    从类复制的说明: Session
    
    Returns the isolation level.
    
    指定者:
    
    getIsolationLevel 在类中 Session
    
    返回:
    
    the isolation level
  - setIsolationLevel
```
public void setIsolationLevel(IsolationLevel isolationLevel)
```
    从类复制的说明: Session
    
    Sets the isolation level.
    
    指定者:
    
    setIsolationLevel 在类中 Session
    
    参数:
    
    isolationLevel - the isolation level to set
  - getStaticSettings
```
public Session.StaticSettings getStaticSettings()
```
    从类复制的说明: Session
    
    Returns static settings. These settings cannot be changed during lifecycle of session.
    
    指定者:
    
    getStaticSettings 在类中 Session
    
    返回:
    
    static settings
  - getDynamicSettings
```
public Session.DynamicSettings getDynamicSettings()
```
    从类复制的说明: Session
    
    Returns dynamic settings. These settings can be changed during lifecycle of session.
    
    指定者:
    
    getDynamicSettings 在类中 Session
    
    返回:
    
    dynamic settings
  - currentTimestamp
```
public ValueTimestampTimeZone currentTimestamp()
```
    从接口复制的说明: CastDataProvider
    
    Returns the current timestamp with maximum resolution. The value must be the same within a transaction or within execution of a command.
    
    指定者:
    
    currentTimestamp 在接口中 CastDataProvider
    
    返回:
    
    the current timestamp for CURRENT_TIMESTAMP(9)
  - currentTimeZone
```
public TimeZoneProvider currentTimeZone()
```
    从接口复制的说明: CastDataProvider
    
    Returns the current time zone.
    
    指定者:
    
    currentTimeZone 在接口中 CastDataProvider
    
    返回:
    
    the current time zone
  - getMode
```
public Mode getMode()
```
    从接口复制的说明: CastDataProvider
    
    Returns the database mode.
    
    指定者:
    
    getMode 在接口中 CastDataProvider
    
    返回:
    
    the database mode
  - getDatabaseMeta
```
public DatabaseMeta getDatabaseMeta()
```
    从类复制的说明: Session
    
    Returns database meta information.
    
    指定者:
    
    getDatabaseMeta 在类中 Session
    
    返回:
    
    database meta information
  - isOldInformationSchema
```
public boolean isOldInformationSchema()
```
    从类复制的说明: Session
    
    Returns whether INFORMATION_SCHEMA contains old-style tables.
    
    指定者:
    
    isOldInformationSchema 在类中 Session
    
    返回:
    
    whether INFORMATION_SCHEMA contains old-style tables
  - zeroBasedEnums
```
public boolean zeroBasedEnums()
```
    从接口复制的说明: CastDataProvider
    
    Returns are ENUM values 0-based.
    
    指定者:
    
    zeroBasedEnums 在接口中 CastDataProvider
    
    返回:
    
    are ENUM values 0-based

类 SessionRemote

嵌套类概要

从类继承的嵌套类/接口 org.h2.engine.Session

字段概要

构造器概要

方法概要

从类继承的方法 org.h2.engine.Session

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

字段详细资料

SESSION_PREPARE

SESSION_CLOSE

COMMAND_EXECUTE_QUERY

COMMAND_EXECUTE_UPDATE

COMMAND_CLOSE

RESULT_FETCH_ROWS

RESULT_RESET

RESULT_CLOSE

COMMAND_COMMIT

CHANGE_ID

COMMAND_GET_META_DATA

SESSION_SET_ID

SESSION_CANCEL_STATEMENT

SESSION_CHECK_KEY

SESSION_SET_AUTOCOMMIT

SESSION_HAS_PENDING_TRANSACTION

LOB_READ

SESSION_PREPARE_READ_PARAMS2

GET_JDBC_META

STATUS_ERROR

STATUS_OK

STATUS_CLOSED

STATUS_OK_STATE_CHANGED

构造器详细资料

SessionRemote

方法详细资料

getClusterServers

hasPendingTransaction

cancel

cancelStatement

getClientVersion

getAutoCommit

setAutoCommit

setAutoCommitFromServer

autoCommitIfCluster

connectEmbeddedOrServer

removeServer

prepareCommand

checkClosed

close

getTrace

getNextId

getCurrentId

done

readException

isClustered

isClosed

traceOperation

checkPowerOff

checkWritingAllowed

getDatabasePath

getMaxLengthInplaceLob

openFile

getDataHandler

getLobSyncObject

getLobFileListCache

getLastReconnect

getTempFileDeleter

getLobStorage

readLob

getJavaObjectSerializer

addTemporaryLob

getCompareMode

isRemote

getCurrentSchemaName

setCurrentSchemaName

setNetworkConnectionInfo

getIsolationLevel

setIsolationLevel

getStaticSettings

getDynamicSettings