PageDataIndex (H2 Database Engine wt-1.0.1 API)

java.lang.Object
- org.h2.engine.DbObjectBase
- - org.h2.schema.SchemaObjectBase
  - - org.h2.index.BaseIndex
    - - org.h2.index.PageIndex
      - org.h2.index.PageDataIndex

所有已实现的接口:

DbObject, Index, SchemaObject
```
public class PageDataIndex
extends PageIndex
```
The scan index allows to access a row by key. It can be used to iterate over all rows of a table. Each regular table has one such object, even if no primary key or indexes are defined.

字段概要
- 从类继承的字段 org.h2.index.PageIndex
  rootPageId
- 从类继承的字段 org.h2.index.BaseIndex
  columnIds, columns, indexColumns, indexType, isMultiVersion, table
- 从类继承的字段 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

构造器概要

构造器
构造器和说明
`PageDataIndex(RegularTable table, int id, IndexColumn[] columns, IndexType indexType, boolean create, Session session)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(Session session, Row row)` Add a row to the index.
`boolean`	`canGetFirstOrLast()` Check if the index can directly look up the lowest or highest value of a column.
`void`	`checkRename()` Check if this object can be renamed.
`void`	`close(Session session)` Close this index.
`void`	`commit(int operation, Row row)` Commit the operation for a row.
`Cursor`	`find(Session session, SearchRow first, SearchRow last)` Find a row or a list of rows and create a cursor to iterate over the result.
`Cursor`	`findFirstOrLast(Session session, boolean first)` Find the first (or last) value of this index.
`int`	`getColumnIndex(Column col)` Get the index of a column in the list of index columns
`double`	`getCost(Session session, int[] masks, TableFilter[] filters, int filter, SortOrder sortOrder, HashSet<Column> allColumnsSet)` Estimate the cost to search for rows given the search mask.
`String`	`getCreateSQL()` Build a SQL statement to re-create this object.
`long`	`getDiskSpaceUsed()` Get the used disk space for this index.
`DbException`	`getDuplicateKeyException(String key)` Create a duplicate key exception with a message that contains the index name.
`int`	`getMainIndexColumn()`
`DbException`	`getNewDuplicateKeyException()`
`String`	`getPlanSQL()` Get the message to show in a EXPLAIN statement.
`Row`	`getRow(Session session, long key)` Get the row with the given key.
`long`	`getRowCount(Session session)` Get the row count of this table, for the given session.
`long`	`getRowCountApproximation()` Get the approximated row count for this table.
`Row`	`getRowWithKey(long key)` Get the row with the given key.
`boolean`	`isRowIdIndex()` Does this index support lookup by row id?
`boolean`	`needRebuild()` Check if the index needs to be rebuilt.
`void`	`remove(Session session)` Remove the index.
`void`	`remove(Session session, Row row)` Remove a row from the index.
`void`	`setMainIndexColumn(int mainIndexColumn)`
`String`	`toString()`
`void`	`truncate(Session session)` Remove all rows from the index.
`void`	`writeRowCount()` Write back the row count if it has changed.

从类继承的方法 org.h2.index.PageIndex
getRootPageId, setSortedInsertMode

从类继承的方法 org.h2.index.BaseIndex
canFindNext, canScan, checkIndexColumnTypes, compareRows, containsNullAndAllowMultipleNull, createLookupBatch, find, findNext, getColumns, getCostRangeIndex, getCreateSQLForCopy, getDropSQL, getIndexColumns, getIndexType, getTable, getType, initBaseIndex, isHidden, removeChildrenAndResources

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

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

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

从接口继承的方法 org.h2.schema.SchemaObject
getSchema

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

- 构造器详细资料
  - PageDataIndex
```
public PageDataIndex(RegularTable table,
                     int id,
                     IndexColumn[] columns,
                     IndexType indexType,
                     boolean create,
                     Session session)
```
- 方法详细资料
  - getDuplicateKeyException
```
public DbException getDuplicateKeyException(String key)
```
    从类复制的说明: BaseIndex
    
    Create a duplicate key exception with a message that contains the index name.
    
    覆盖:
    
    getDuplicateKeyException 在类中 BaseIndex
    
    参数:
    
    key - the key values
    
    返回:
    
    the exception
  - add
```
public void add(Session session,
                Row row)
```
    从接口复制的说明: Index
    
    Add a row to the index.
    
    参数:
    
    session - the session to use
    
    row - the row to add
  - getNewDuplicateKeyException
```
public DbException getNewDuplicateKeyException()
```
  - canGetFirstOrLast
```
public boolean canGetFirstOrLast()
```
    从接口复制的说明: Index
    
    Check if the index can directly look up the lowest or highest value of a column.
    
    返回:
    
    true if it can
  - find
```
public Cursor find(Session session,
                   SearchRow first,
                   SearchRow last)
```
    从接口复制的说明: Index
    
    Find a row or a list of rows and create a cursor to iterate over the result.
    
    参数:
    
    session - the session
    
    first - the first row, or null for no limit
    
    last - the last row, or null for no limit
    
    返回:
    
    the cursor to iterate over the results
  - findFirstOrLast
```
public Cursor findFirstOrLast(Session session,
                              boolean first)
```
    从接口复制的说明: Index
    
    Find the first (or last) value of this index. The cursor returned is positioned on the correct row, or on null if no row has been found.
    
    参数:
    
    session - the session
    
    first - true if the first (lowest for ascending indexes) or last value should be returned
    
    返回:
    
    a cursor (never null)
  - getCost
```
public double getCost(Session session,
                      int[] masks,
                      TableFilter[] filters,
                      int filter,
                      SortOrder sortOrder,
                      HashSet<Column> allColumnsSet)
```
    从接口复制的说明: Index
    
    Estimate the cost to search for rows given the search mask. There is one element per column in the search mask. For possible search masks, see IndexCondition.
    
    参数:
    
    session - the session
    
    masks - per-column comparison bit masks, null means 'always false', see constants in IndexCondition
    
    filters - all joined table filters
    
    filter - the current table filter index
    
    sortOrder - the sort order
    
    allColumnsSet - the set of all columns
    
    返回:
    
    the estimated cost
  - needRebuild
```
public boolean needRebuild()
```
    从接口复制的说明: Index
    
    Check if the index needs to be rebuilt. This method is called after opening an index.
    
    返回:
    
    true if a rebuild is required.
  - remove
```
public void remove(Session session,
                   Row row)
```
    从接口复制的说明: Index
    
    Remove a row from the index.
    
    参数:
    
    session - the session
    
    row - the row
  - remove
```
public void remove(Session session)
```
    从接口复制的说明: Index
    
    Remove the index.
    
    参数:
    
    session - the session
  - truncate
```
public void truncate(Session session)
```
    从接口复制的说明: Index
    
    Remove all rows from the index.
    
    参数:
    
    session - the session
  - checkRename
```
public void checkRename()
```
    从类复制的说明: DbObjectBase
    
    Check if this object can be renamed. System objects may not be renamed.
    
    指定者:
    
    checkRename 在接口中 DbObject
    
    指定者:
    
    checkRename 在类中 DbObjectBase
  - getRow
```
public Row getRow(Session session,
                  long key)
```
    从接口复制的说明: Index
    
    Get the row with the given key.
    
    指定者:
    
    getRow 在接口中 Index
    
    覆盖:
    
    getRow 在类中 BaseIndex
    
    参数:
    
    session - the session
    
    key - the unique key
    
    返回:
    
    the row
  - getRowWithKey
```
public Row getRowWithKey(long key)
```
    Get the row with the given key.
    
    参数:
    
    key - the key
    
    返回:
    
    the row
  - getRowCountApproximation
```
public long getRowCountApproximation()
```
    从接口复制的说明: Index
    
    Get the approximated row count for this table.
    
    返回:
    
    the approximated row count
  - getRowCount
```
public long getRowCount(Session session)
```
    从接口复制的说明: Index
    
    Get the row count of this table, for the given session.
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    从接口复制的说明: Index
    
    Get the used disk space for this index.
    
    返回:
    
    the estimated number of bytes
  - getCreateSQL
```
public String getCreateSQL()
```
    从类复制的说明: DbObjectBase
    
    Build a SQL statement to re-create this object.
    
    指定者:
    
    getCreateSQL 在接口中 DbObject
    
    覆盖:
    
    getCreateSQL 在类中 BaseIndex
    
    返回:
    
    the SQL statement
  - getColumnIndex
```
public int getColumnIndex(Column col)
```
    从接口复制的说明: Index
    
    Get the index of a column in the list of index columns
    
    指定者:
    
    getColumnIndex 在接口中 Index
    
    覆盖:
    
    getColumnIndex 在类中 BaseIndex
    
    参数:
    
    col - the column
    
    返回:
    
    the index (0 meaning first column)
  - close
```
public void close(Session session)
```
    从接口复制的说明: Index
    
    Close this index.
    
    参数:
    
    session - the session used to write data
  - commit
```
public void commit(int operation,
                   Row row)
```
    从接口复制的说明: Index
    
    Commit the operation for a row. This is only important for multi-version indexes. The method is only called if multi-version is enabled.
    
    指定者:
    
    commit 在接口中 Index
    
    覆盖:
    
    commit 在类中 BaseIndex
    
    参数:
    
    operation - the operation type
    
    row - the row
  - setMainIndexColumn
```
public void setMainIndexColumn(int mainIndexColumn)
```
  - getMainIndexColumn
```
public int getMainIndexColumn()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 DbObjectBase
  - writeRowCount
```
public void writeRowCount()
```
    从类复制的说明: PageIndex
    
    Write back the row count if it has changed.
    
    指定者:
    
    writeRowCount 在类中 PageIndex
  - getPlanSQL
```
public String getPlanSQL()
```
    从接口复制的说明: Index
    
    Get the message to show in a EXPLAIN statement.
    
    指定者:
    
    getPlanSQL 在接口中 Index
    
    覆盖:
    
    getPlanSQL 在类中 BaseIndex
    
    返回:
    
    the plan
  - isRowIdIndex
```
public boolean isRowIdIndex()
```
    从接口复制的说明: Index
    
    Does this index support lookup by row id?
    
    指定者:
    
    isRowIdIndex 在接口中 Index
    
    覆盖:
    
    isRowIdIndex 在类中 BaseIndex
    
    返回:
    
    true if it does

类 PageDataIndex

字段概要

从类继承的字段 org.h2.index.PageIndex

从类继承的字段 org.h2.index.BaseIndex

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

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

构造器概要

方法概要

从类继承的方法 org.h2.index.PageIndex

从类继承的方法 org.h2.index.BaseIndex

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

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

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

从接口继承的方法 org.h2.schema.SchemaObject

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

构造器详细资料

PageDataIndex

方法详细资料

getDuplicateKeyException

add

getNewDuplicateKeyException

canGetFirstOrLast

find

findFirstOrLast

getCost

needRebuild

remove

remove

truncate

checkRename

getRow

getRowWithKey

getRowCountApproximation

getRowCount

getDiskSpaceUsed

getCreateSQL

getColumnIndex

close

commit

setMainIndexColumn

getMainIndexColumn

toString

writeRowCount

getPlanSQL

isRowIdIndex