TableLink (H2 Database Engine wt-1.0.1 API)

java.lang.Object
- org.h2.engine.DbObjectBase
- - org.h2.schema.SchemaObjectBase
  - - org.h2.table.Table
    - - org.h2.table.TableLink

所有已实现的接口:

DbObject, SchemaObject
```
public class TableLink
extends Table
```
A linked table contains connection information for a table accessible by JDBC. The table may be stored in a different database.

字段概要
- 从类继承的字段 org.h2.table.Table
  columns, compareMode, isHidden, TYPE_CACHED, TYPE_MEMORY
- 从类继承的字段 org.h2.engine.DbObjectBase
  comment, database, trace
- 从接口继承的字段 org.h2.engine.DbObject
  AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

构造器概要

构造器
构造器和说明
`TableLink(Schema schema, int id, String name, String driver, String url, String user, String password, String originalSchema, String originalTable, boolean emitUpdates, boolean force)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Index`	`addIndex(Session session, String indexName, int indexId, IndexColumn[] cols, IndexType indexType, boolean create, String indexComment)` Create an index for this table
`void`	`addRow(Session session, Row row)` Add a row to the table and all indexes.
`boolean`	`canDrop()` Check if this table can be dropped.
`boolean`	`canGetRowCount()` Check if the row count can be retrieved quickly.
`void`	`checkRename()` Check if this object can be renamed.
`void`	`checkSupportAlter()` Check if this table supports ALTER TABLE.
`void`	`checkWritingAllowed()` Linked tables don't know if they are readonly.
`void`	`close(Session session)` Close the table object and flush changes.
`PreparedStatement`	`execute(String sql, ArrayList<Value> params, boolean reusePrepared)` Execute a SQL statement using the given parameters.
`String`	`getCreateSQL()` Build a SQL statement to re-create this object.
`Value`	`getDefaultValue(Session session, Column column)` Get or generate a default value for the given column.
`long`	`getDiskSpaceUsed()`
`String`	`getDropSQL()` Build a SQL statement to drop this object.
`ArrayList<Index>`	`getIndexes()` Get all indexes for this table.
`long`	`getMaxDataModificationId()` Get the last data modification id.
`String`	`getQualifiedTable()`
`long`	`getRowCount(Session session)` Get the row count for this table.
`long`	`getRowCountApproximation()` Get the approximated row count for this table.
`Index`	`getScanIndex(Session session)` Get the scan index to iterate through all rows.
`TableType`	`getTableType()` Get the table type name
`Index`	`getUniqueIndex()` Get any unique index for this table if one exists.
`boolean`	`isDeterministic()` Check if the table is deterministic.
`boolean`	`isLockedExclusively()` Check if this table is locked exclusively.
`boolean`	`isOracle()`
`boolean`	`lock(Session session, boolean exclusive, boolean forceLockEvenInMvcc)` Lock the table for the given session.
`void`	`removeChildrenAndResources(Session session)` Remove all dependent objects and free all resources (files, blocks in files) of this object.
`void`	`removeRow(Session session, Row row)` Remove a row from the table and all indexes.
`void`	`reusePreparedStatement(PreparedStatement prep, String sql)` Add this prepared statement to the list of cached statements.
`void`	`setGlobalTemporary(boolean globalTemporary)`
`void`	`setReadOnly(boolean readOnly)`
`void`	`truncate(Session session)` Remove all rows from the table and indexes.
`void`	`unlock(Session s)` Release the lock for this session.
`void`	`updateRows(Prepared prepared, Session session, RowList rows)` Update a list of rows in this table.
`void`	`validateConvertUpdateSequence(Session session, Row row)` Convert the values if required.
`static DbException`	`wrapException(String sql, Exception ex)` Wrap a SQL exception that occurred while accessing a linked table.

从类继承的方法 org.h2.table.Table
addConstraint, addDependencies, addSequence, addTrigger, addView, canReference, canTruncate, checkDeadlock, commit, compareTypeSafe, doesColumnExist, dropMultipleColumnsConstraintsAndIndexes, findPrimaryKey, fire, fireAfterRow, fireBeforeRow, fireRow, getBestPlanItem, getCheckForeignKeyConstraints, getChildren, getColumn, getColumn, getColumns, getCompareMode, getConstraints, getCreateSQLForCopy, getIndexForColumn, getOnCommitDrop, getOnCommitTruncate, getPrimaryKey, getRow, getRowIdColumn, getScanIndex, getTemplateRow, getTemplateSimpleRow, getType, getViews, hasSelectTrigger, isGlobalTemporary, isHidden, isLockedExclusivelyBy, isMVStore, isPersistData, isPersistIndexes, isQueryComparable, isView, removeConstraint, removeIndex, removeIndexOrTransferOwnership, removeSequence, removeTrigger, removeView, rename, renameColumn, setCheckForeignKeyConstraints, setColumns, setHidden, setOnCommitDrop, setOnCommitTruncate

从类继承的方法 org.h2.schema.SchemaObjectBase
getSchema, getSQL, initSchemaObjectBase

从类继承的方法 org.h2.engine.DbObjectBase
getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, invalidate, isTemporary, isValid, setComment, setModified, setObjectName, setTemporary, toString

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

从接口继承的方法 org.h2.engine.DbObject
getComment, getDatabase, getId, getName, isTemporary, setComment, setTemporary

- 构造器详细资料
  - TableLink
```
public TableLink(Schema schema,
                 int id,
                 String name,
                 String driver,
                 String url,
                 String user,
                 String password,
                 String originalSchema,
                 String originalTable,
                 boolean emitUpdates,
                 boolean force)
```
- 方法详细资料
  - getDropSQL
```
public String getDropSQL()
```
    从类复制的说明: DbObjectBase
    
    Build a SQL statement to drop this object.
    
    指定者:
    
    getDropSQL 在接口中 DbObject
    
    指定者:
    
    getDropSQL 在类中 DbObjectBase
    
    返回:
    
    the SQL statement
  - getCreateSQL
```
public String getCreateSQL()
```
    从类复制的说明: DbObjectBase
    
    Build a SQL statement to re-create this object.
    
    指定者:
    
    getCreateSQL 在接口中 DbObject
    
    指定者:
    
    getCreateSQL 在类中 DbObjectBase
    
    返回:
    
    the SQL statement
  - addIndex
```
public Index addIndex(Session session,
                      String indexName,
                      int indexId,
                      IndexColumn[] cols,
                      IndexType indexType,
                      boolean create,
                      String indexComment)
```
    从类复制的说明: Table
    
    Create an index for this table
    
    指定者:
    
    addIndex 在类中 Table
    
    参数:
    
    session - the session
    
    indexName - the name of the index
    
    indexId - the id
    
    cols - the index columns
    
    indexType - the index type
    
    create - whether this is a new index
    
    indexComment - the comment
    
    返回:
    
    the index
  - lock
```
public boolean lock(Session session,
                    boolean exclusive,
                    boolean forceLockEvenInMvcc)
```
    从类复制的说明: Table
    
    Lock the table for the given session. This method waits until the lock is granted.
    
    指定者:
    
    lock 在类中 Table
    
    参数:
    
    session - the session
    
    exclusive - true for write locks, false for read locks
    
    forceLockEvenInMvcc - lock even in the MVCC mode
    
    返回:
    
    true if the table was already exclusively locked by this session.
  - isLockedExclusively
```
public boolean isLockedExclusively()
```
    从类复制的说明: Table
    
    Check if this table is locked exclusively.
    
    指定者:
    
    isLockedExclusively 在类中 Table
    
    返回:
    
    true if it is.
  - getScanIndex
```
public Index getScanIndex(Session session)
```
    从类复制的说明: Table
    
    Get the scan index to iterate through all rows.
    
    指定者:
    
    getScanIndex 在类中 Table
    
    参数:
    
    session - the session
    
    返回:
    
    the index
  - removeRow
```
public void removeRow(Session session,
                      Row row)
```
    从类复制的说明: Table
    
    Remove a row from the table and all indexes.
    
    指定者:
    
    removeRow 在类中 Table
    
    参数:
    
    session - the session
    
    row - the row
  - addRow
```
public void addRow(Session session,
                   Row row)
```
    从类复制的说明: Table
    
    Add a row to the table and all indexes.
    
    指定者:
    
    addRow 在类中 Table
    
    参数:
    
    session - the session
    
    row - the row
  - close
```
public void close(Session session)
```
    从类复制的说明: Table
    
    Close the table object and flush changes.
    
    指定者:
    
    close 在类中 Table
    
    参数:
    
    session - the session
  - getRowCount
```
public long getRowCount(Session session)
```
    从类复制的说明: Table
    
    Get the row count for this table.
    
    指定者:
    
    getRowCount 在类中 Table
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - wrapException
```
public static DbException wrapException(String sql,
                                        Exception ex)
```
    Wrap a SQL exception that occurred while accessing a linked table.
    
    参数:
    
    sql - the SQL statement
    
    ex - the exception from the remote database
    
    返回:
    
    the wrapped exception
  - getQualifiedTable
```
public String getQualifiedTable()
```
  - execute
```
public PreparedStatement execute(String sql,
                                 ArrayList<Value> params,
                                 boolean reusePrepared)
```
    Execute a SQL statement using the given parameters. Prepared statements are kept in a hash map to avoid re-creating them.
    
    参数:
    
    sql - the SQL statement
    
    params - the parameters or null
    
    reusePrepared - if the prepared statement can be re-used immediately
    
    返回:
    
    the prepared statement, or null if it is re-used
  - unlock
```
public void unlock(Session s)
```
    从类复制的说明: Table
    
    Release the lock for this session.
    
    指定者:
    
    unlock 在类中 Table
    
    参数:
    
    s - the session
  - checkRename
```
public void checkRename()
```
    从类复制的说明: DbObjectBase
    
    Check if this object can be renamed. System objects may not be renamed.
    
    指定者:
    
    checkRename 在接口中 DbObject
    
    指定者:
    
    checkRename 在类中 DbObjectBase
  - checkSupportAlter
```
public void checkSupportAlter()
```
    从类复制的说明: Table
    
    Check if this table supports ALTER TABLE.
    
    指定者:
    
    checkSupportAlter 在类中 Table
  - truncate
```
public void truncate(Session session)
```
    从类复制的说明: Table
    
    Remove all rows from the table and indexes.
    
    指定者:
    
    truncate 在类中 Table
    
    参数:
    
    session - the session
  - canGetRowCount
```
public boolean canGetRowCount()
```
    从类复制的说明: Table
    
    Check if the row count can be retrieved quickly.
    
    指定者:
    
    canGetRowCount 在类中 Table
    
    返回:
    
    true if it can
  - canDrop
```
public boolean canDrop()
```
    从类复制的说明: Table
    
    Check if this table can be dropped.
    
    指定者:
    
    canDrop 在类中 Table
    
    返回:
    
    true if it can
  - getTableType
```
public TableType getTableType()
```
    从类复制的说明: Table
    
    Get the table type name
    
    指定者:
    
    getTableType 在类中 Table
    
    返回:
    
    the table type name
  - removeChildrenAndResources
```
public void removeChildrenAndResources(Session session)
```
    从类复制的说明: DbObjectBase
    
    Remove all dependent objects and free all resources (files, blocks in files) of this object.
    
    指定者:
    
    removeChildrenAndResources 在接口中 DbObject
    
    覆盖:
    
    removeChildrenAndResources 在类中 Table
    
    参数:
    
    session - the session
  - isOracle
```
public boolean isOracle()
```
  - getIndexes
```
public ArrayList<Index> getIndexes()
```
    从类复制的说明: Table
    
    Get all indexes for this table.
    
    指定者:
    
    getIndexes 在类中 Table
    
    返回:
    
    the list of indexes
  - getMaxDataModificationId
```
public long getMaxDataModificationId()
```
    从类复制的说明: Table
    
    Get the last data modification id.
    
    指定者:
    
    getMaxDataModificationId 在类中 Table
    
    返回:
    
    the modification id
  - getUniqueIndex
```
public Index getUniqueIndex()
```
    从类复制的说明: Table
    
    Get any unique index for this table if one exists.
    
    指定者:
    
    getUniqueIndex 在类中 Table
    
    返回:
    
    a unique index
  - updateRows
```
public void updateRows(Prepared prepared,
                       Session session,
                       RowList rows)
```
    从类复制的说明: Table
    
    Update a list of rows in this table.
    
    覆盖:
    
    updateRows 在类中 Table
    
    参数:
    
    prepared - the prepared statement
    
    session - the session
    
    rows - a list of row pairs of the form old row, new row, old row, new row,...
  - setGlobalTemporary
```
public void setGlobalTemporary(boolean globalTemporary)
```
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  - getRowCountApproximation
```
public long getRowCountApproximation()
```
    从类复制的说明: Table
    
    Get the approximated row count for this table.
    
    指定者:
    
    getRowCountApproximation 在类中 Table
    
    返回:
    
    the approximated row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    指定者:
    
    getDiskSpaceUsed 在类中 Table
  - reusePreparedStatement
```
public void reusePreparedStatement(PreparedStatement prep,
                                   String sql)
```
    Add this prepared statement to the list of cached statements.
    
    参数:
    
    prep - the prepared statement
    
    sql - the SQL statement
  - isDeterministic
```
public boolean isDeterministic()
```
    从类复制的说明: Table
    
    Check if the table is deterministic.
    
    指定者:
    
    isDeterministic 在类中 Table
    
    返回:
    
    true if it is
  - checkWritingAllowed
```
public void checkWritingAllowed()
```
    Linked tables don't know if they are readonly. This overwrites the default handling.
    
    覆盖:
    
    checkWritingAllowed 在类中 Table
  - validateConvertUpdateSequence
```
public void validateConvertUpdateSequence(Session session,
                                          Row row)
```
    Convert the values if required. Default values are not set (kept as null).
    
    覆盖:
    
    validateConvertUpdateSequence 在类中 Table
    
    参数:
    
    session - the session
    
    row - the row
  - getDefaultValue
```
public Value getDefaultValue(Session session,
                             Column column)
```
    Get or generate a default value for the given column. Default values are not set (kept as null).
    
    覆盖:
    
    getDefaultValue 在类中 Table
    
    参数:
    
    session - the session
    
    column - the column
    
    返回:
    
    the value

类 TableLink

字段概要

从类继承的字段 org.h2.table.Table

从类继承的字段 org.h2.engine.DbObjectBase

从接口继承的字段 org.h2.engine.DbObject

构造器概要

方法概要

从类继承的方法 org.h2.table.Table

从类继承的方法 org.h2.schema.SchemaObjectBase

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

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

从接口继承的方法 org.h2.engine.DbObject

构造器详细资料

TableLink

方法详细资料

getDropSQL

getCreateSQL

addIndex

lock

isLockedExclusively

getScanIndex

removeRow

addRow

close

getRowCount

wrapException

getQualifiedTable

execute

unlock

checkRename

checkSupportAlter

truncate

canGetRowCount

canDrop

getTableType

removeChildrenAndResources

isOracle

getIndexes

getMaxDataModificationId

getUniqueIndex

updateRows

setGlobalTemporary

setReadOnly

getRowCountApproximation

getDiskSpaceUsed

reusePreparedStatement

isDeterministic

checkWritingAllowed

validateConvertUpdateSequence

getDefaultValue