RegularTable (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.TableBase
      - org.h2.table.RegularTable

所有已实现的接口:

DbObject, SchemaObject
```
public class RegularTable
extends TableBase
```
Most tables are an instance of this class. For this table, the data is stored in the database. The actual data is not kept here, instead it is kept in the indexes. There is at least one index, the scan index.

字段概要
- 从类继承的字段 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

构造器概要

构造器
构造器和说明

RegularTable(CreateTableData data)

构造器
构造器和说明
`RegularTable(CreateTableData data)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`boolean`	`canTruncate()` Check if this table can be truncated.
`ArrayList<Session>`	`checkDeadlock(Session session, Session clash, Set<Session> visited)` Check if a deadlock occurred.
`void`	`checkRename()` Check if this object can be renamed.
`void`	`checkSupportAlter()` Check if this table supports ALTER TABLE.
`void`	`close(Session session)` Close the table object and flush changes.
`void`	`commit(short operation, Row row)` Commit an operation (when using multi-version concurrency).
`boolean`	`getContainsLargeObject()`
`long`	`getDiskSpaceUsed()`
`ArrayList<Index>`	`getIndexes()` Get all indexes for this table.
`long`	`getMaxDataModificationId()` Get the last data modification id.
`Row`	`getRow(Session session, long key)` Get the given row.
`long`	`getRowCount(Session session)` Get the row count for this table.
`long`	`getRowCountApproximation()` Get the approximated row count for this table.
`Column`	`getRowIdColumn()` Get the row id column if this table has one.
`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`	`isLockedExclusivelyBy(Session session)` Check if the table is exclusively locked by this session.
`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`	`setCompareMode(CompareMode compareMode)`
`void`	`setRowCount(long count)` Set the row count of this table.
`String`	`toString()`
`void`	`truncate(Session session)` Remove all rows from the table and indexes.
`void`	`unlock(Session s)` Release the lock for this session.

从类继承的方法 org.h2.table.TableBase
getCreateSQL, getDropSQL, isGlobalTemporary

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

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

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

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

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

- 构造器详细资料
  - RegularTable
```
public RegularTable(CreateTableData data)
```
- 方法详细资料
  - close
```
public void close(Session session)
```
    从类复制的说明: Table
    
    Close the table object and flush changes.
    
    指定者:
    
    close 在类中 Table
    
    参数:
    
    session - the session
  - getRow
```
public Row getRow(Session session,
                  long key)
```
    从类复制的说明: Table
    
    Get the given row.
    
    覆盖:
    
    getRow 在类中 Table
    
    参数:
    
    session - the session
    
    key - the primary key
    
    返回:
    
    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
  - commit
```
public void commit(short operation,
                   Row row)
```
    从类复制的说明: Table
    
    Commit an operation (when using multi-version concurrency).
    
    覆盖:
    
    commit 在类中 Table
    
    参数:
    
    operation - the operation
    
    row - the row
  - getScanIndex
```
public Index getScanIndex(Session session)
```
    从类复制的说明: Table
    
    Get the scan index to iterate through all rows.
    
    指定者:
    
    getScanIndex 在类中 Table
    
    参数:
    
    session - the session
    
    返回:
    
    the index
  - getUniqueIndex
```
public Index getUniqueIndex()
```
    从类复制的说明: Table
    
    Get any unique index for this table if one exists.
    
    指定者:
    
    getUniqueIndex 在类中 Table
    
    返回:
    
    a unique index
  - getIndexes
```
public ArrayList<Index> getIndexes()
```
    从类复制的说明: Table
    
    Get all indexes for this table.
    
    指定者:
    
    getIndexes 在类中 Table
    
    返回:
    
    the list of indexes
  - 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
  - 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
  - getRowCount
```
public long getRowCount(Session session)
```
    从类复制的说明: Table
    
    Get the row count for this table.
    
    指定者:
    
    getRowCount 在类中 Table
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - 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
  - truncate
```
public void truncate(Session session)
```
    从类复制的说明: Table
    
    Remove all rows from the table and indexes.
    
    指定者:
    
    truncate 在类中 Table
    
    参数:
    
    session - the session
  - isLockedExclusivelyBy
```
public boolean isLockedExclusivelyBy(Session session)
```
    从类复制的说明: Table
    
    Check if the table is exclusively locked by this session.
    
    覆盖:
    
    isLockedExclusivelyBy 在类中 Table
    
    参数:
    
    session - the session
    
    返回:
    
    true if it is
  - 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.
  - checkDeadlock
```
public ArrayList<Session> checkDeadlock(Session session,
                                        Session clash,
                                        Set<Session> visited)
```
    从类复制的说明: Table
    
    Check if a deadlock occurred. This method is called recursively. There is a circle if the session to be tested has already being visited. If this session is part of the circle (if it is the clash session), the method must return an empty object array. Once a deadlock has been detected, the methods must add the session to the list. If this session is not part of the circle, or if no deadlock is detected, this method returns null.
    
    覆盖:
    
    checkDeadlock 在类中 Table
    
    参数:
    
    session - the session to be tested for
    
    clash - set with sessions already visited, and null when starting verification
    
    visited - set with sessions already visited, and null when starting verification
    
    返回:
    
    an object array with the sessions involved in the deadlock, or null
  - isLockedExclusively
```
public boolean isLockedExclusively()
```
    从类复制的说明: Table
    
    Check if this table is locked exclusively.
    
    指定者:
    
    isLockedExclusively 在类中 Table
    
    返回:
    
    true if it is.
  - unlock
```
public void unlock(Session s)
```
    从类复制的说明: Table
    
    Release the lock for this session.
    
    指定者:
    
    unlock 在类中 Table
    
    参数:
    
    s - the session
  - setRowCount
```
public void setRowCount(long count)
```
    Set the row count of this table.
    
    参数:
    
    count - the row count
  - 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
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 DbObjectBase
  - 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
  - canTruncate
```
public boolean canTruncate()
```
    从类复制的说明: Table
    
    Check if this table can be truncated.
    
    覆盖:
    
    canTruncate 在类中 Table
    
    返回:
    
    true if it can
  - getTableType
```
public TableType getTableType()
```
    从类复制的说明: Table
    
    Get the table type name
    
    指定者:
    
    getTableType 在类中 Table
    
    返回:
    
    the table type name
  - getMaxDataModificationId
```
public long getMaxDataModificationId()
```
    从类复制的说明: Table
    
    Get the last data modification id.
    
    指定者:
    
    getMaxDataModificationId 在类中 Table
    
    返回:
    
    the modification id
  - getContainsLargeObject
```
public boolean getContainsLargeObject()
```
  - 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
  - setCompareMode
```
public void setCompareMode(CompareMode compareMode)
```
  - isDeterministic
```
public boolean isDeterministic()
```
    从类复制的说明: Table
    
    Check if the table is deterministic.
    
    指定者:
    
    isDeterministic 在类中 Table
    
    返回:
    
    true if it is
  - getRowIdColumn
```
public Column getRowIdColumn()
```
    从类复制的说明: Table
    
    Get the row id column if this table has one.
    
    覆盖:
    
    getRowIdColumn 在类中 Table
    
    返回:
    
    the row id column, or null

类 RegularTable

字段概要

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

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

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

构造器概要

方法概要

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

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

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

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

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

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

构造器详细资料

RegularTable

方法详细资料

close

getRow

addRow

commit

getScanIndex

getUniqueIndex

getIndexes

addIndex

canGetRowCount

canDrop

getRowCount

removeRow

truncate

isLockedExclusivelyBy

lock

checkDeadlock

isLockedExclusively

unlock

setRowCount

removeChildrenAndResources

toString

checkRename

checkSupportAlter

canTruncate

getTableType

getMaxDataModificationId

getContainsLargeObject

getRowCountApproximation

getDiskSpaceUsed

setCompareMode

isDeterministic

getRowIdColumn