MultiVersionIndex (H2 Database Engine wt-1.0.1 API)

java.lang.Object
- org.h2.index.MultiVersionIndex

所有已实现的接口:

DbObject, Index, SchemaObject
```
public class MultiVersionIndex
extends Object
implements Index
```
A multi-version index is a combination of a regular index, and a in-memory tree index that contains uncommitted changes. Uncommitted changes can include new rows, and deleted rows.

字段概要
- 从接口继承的字段 org.h2.engine.DbObject
  AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

构造器概要

构造器
构造器和说明

MultiVersionIndex(Index base, RegularTable table)

构造器
构造器和说明
`MultiVersionIndex(Index base, RegularTable table)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(Session session, Row row)` Add a row to the index.
`boolean`	`canFindNext()` Check if the index can get the next higher value.
`boolean`	`canGetFirstOrLast()` Check if the index can directly look up the lowest or highest value of a column.
`boolean`	`canScan()` Can this index iterate over all rows?
`void`	`checkRename()` Check if renaming is allowed.
`void`	`close(Session session)` Close this index.
`void`	`commit(int operation, Row row)` Commit the operation for a row.
`int`	`compareRows(SearchRow rowData, SearchRow compare)` Compare two rows.
`IndexLookupBatch`	`createLookupBatch(TableFilter[] filters, int filter)` Creates new lookup batch.
`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`	`find(TableFilter filter, 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.
`Cursor`	`findNext(Session session, SearchRow first, SearchRow last)` Find a row or a list of rows that is larger and create a cursor to iterate over the result.
`Index`	`getBaseIndex()`
`ArrayList<DbObject>`	`getChildren()` Get the list of dependent children (for tables, this includes indexes and so on).
`int`	`getColumnIndex(Column col)` Get the index of a column in the list of index columns
`Column[]`	`getColumns()` Get the indexed columns.
`String`	`getComment()` Get the current comment of this object.
`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()` Construct the original CREATE ...
`String`	`getCreateSQLForCopy(Table forTable, String quotedName)` Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
`Database`	`getDatabase()` Get the database.
`long`	`getDiskSpaceUsed()` Get the used disk space for this index.
`String`	`getDropSQL()` Construct a DROP ...
`int`	`getId()` Get the unique object id.
`IndexColumn[]`	`getIndexColumns()` Get the indexed columns as index columns (with ordering information).
`IndexType`	`getIndexType()` Get the index type.
`String`	`getName()` Get the name.
`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.
`Schema`	`getSchema()` Get the schema in which this object is defined
`String`	`getSQL()` Get the SQL name of this object (may be quoted).
`Table`	`getTable()` Get the table on which this index is based.
`int`	`getType()` Get the object type.
`boolean`	`isHidden()` Check whether this is a hidden object that doesn't appear in the meta data and in the script, and is not dropped on DROP ALL OBJECTS.
`boolean`	`isRowIdIndex()` Does this index support lookup by row id?
`boolean`	`isTemporary()` Check if this object is temporary (for example, a temporary table).
`boolean`	`isUncommittedFromOtherSession(Session session, Row row)` Check if there is an uncommitted row with the given key within a different session.
`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`	`removeChildrenAndResources(Session session)` Delete all dependent children objects and resources of this object.
`void`	`rename(String newName)` Rename the object.
`void`	`setComment(String comment)` Change the comment of this object.
`void`	`setSortedInsertMode(boolean sortedInsertMode)` Enable or disable the 'sorted insert' optimizations (rows are inserted in ascending or descending order) if applicable for this index implementation.
`void`	`setTemporary(boolean temporary)` Tell this object that it is temporary or not.
`void`	`truncate(Session session)` Remove all rows from the index.

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

- 构造器详细资料
  - MultiVersionIndex
```
public MultiVersionIndex(Index base,
                         RegularTable table)
```
- 方法详细资料
  - add
```
public void add(Session session,
                Row row)
```
    从接口复制的说明: Index
    
    Add a row to the index.
    
    指定者:
    
    add 在接口中 Index
    
    参数:
    
    session - the session to use
    
    row - the row to add
  - close
```
public void close(Session session)
```
    从接口复制的说明: Index
    
    Close this index.
    
    指定者:
    
    close 在接口中 Index
    
    参数:
    
    session - the session used to write data
  - find
```
public Cursor find(TableFilter filter,
                   SearchRow first,
                   SearchRow last)
```
    从接口复制的说明: Index
    
    Find a row or a list of rows and create a cursor to iterate over the result.
    
    指定者:
    
    find 在接口中 Index
    
    参数:
    
    filter - the table filter (which possibly knows about additional conditions)
    
    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
  - 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.
    
    指定者:
    
    find 在接口中 Index
    
    参数:
    
    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
  - findNext
```
public Cursor findNext(Session session,
                       SearchRow first,
                       SearchRow last)
```
    从接口复制的说明: Index
    
    Find a row or a list of rows that is larger and create a cursor to iterate over the result.
    
    指定者:
    
    findNext 在接口中 Index
    
    参数:
    
    session - the session
    
    first - the lower limit (excluding)
    
    last - the last row, or null for no limit
    
    返回:
    
    the cursor
  - canFindNext
```
public boolean canFindNext()
```
    从接口复制的说明: Index
    
    Check if the index can get the next higher value.
    
    指定者:
    
    canFindNext 在接口中 Index
    
    返回:
    
    true if it can
  - canGetFirstOrLast
```
public boolean canGetFirstOrLast()
```
    从接口复制的说明: Index
    
    Check if the index can directly look up the lowest or highest value of a column.
    
    指定者:
    
    canGetFirstOrLast 在接口中 Index
    
    返回:
    
    true if it can
  - 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.
    
    指定者:
    
    findFirstOrLast 在接口中 Index
    
    参数:
    
    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.
    
    指定者:
    
    getCost 在接口中 Index
    
    参数:
    
    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.
    
    指定者:
    
    needRebuild 在接口中 Index
    
    返回:
    
    true if a rebuild is required.
  - isUncommittedFromOtherSession
```
public boolean isUncommittedFromOtherSession(Session session,
                                             Row row)
```
    Check if there is an uncommitted row with the given key within a different session.
    
    参数:
    
    session - the original session
    
    row - the row (only the key is checked)
    
    返回:
    
    true if there is an uncommitted row
  - remove
```
public void remove(Session session,
                   Row row)
```
    从接口复制的说明: Index
    
    Remove a row from the index.
    
    指定者:
    
    remove 在接口中 Index
    
    参数:
    
    session - the session
    
    row - the row
  - remove
```
public void remove(Session session)
```
    从接口复制的说明: Index
    
    Remove the index.
    
    指定者:
    
    remove 在接口中 Index
    
    参数:
    
    session - the session
  - truncate
```
public void truncate(Session session)
```
    从接口复制的说明: Index
    
    Remove all rows from the index.
    
    指定者:
    
    truncate 在接口中 Index
    
    参数:
    
    session - the session
  - 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
    
    参数:
    
    operation - the operation type
    
    row - the row
  - compareRows
```
public int compareRows(SearchRow rowData,
                       SearchRow compare)
```
    从接口复制的说明: Index
    
    Compare two rows.
    
    指定者:
    
    compareRows 在接口中 Index
    
    参数:
    
    rowData - the first row
    
    compare - the second row
    
    返回:
    
    0 if both rows are equal, -1 if the first row is smaller, otherwise 1
  - getColumnIndex
```
public int getColumnIndex(Column col)
```
    从接口复制的说明: Index
    
    Get the index of a column in the list of index columns
    
    指定者:
    
    getColumnIndex 在接口中 Index
    
    参数:
    
    col - the column
    
    返回:
    
    the index (0 meaning first column)
  - getColumns
```
public Column[] getColumns()
```
    从接口复制的说明: Index
    
    Get the indexed columns.
    
    指定者:
    
    getColumns 在接口中 Index
    
    返回:
    
    the columns
  - getIndexColumns
```
public IndexColumn[] getIndexColumns()
```
    从接口复制的说明: Index
    
    Get the indexed columns as index columns (with ordering information).
    
    指定者:
    
    getIndexColumns 在接口中 Index
    
    返回:
    
    the index columns
  - getCreateSQL
```
public String getCreateSQL()
```
    从接口复制的说明: DbObject
    
    Construct the original CREATE ... SQL statement for this object.
    
    指定者:
    
    getCreateSQL 在接口中 DbObject
    
    返回:
    
    the SQL statement
  - getCreateSQLForCopy
```
public String getCreateSQLForCopy(Table forTable,
                                  String quotedName)
```
    从接口复制的说明: DbObject
    
    Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
    
    指定者:
    
    getCreateSQLForCopy 在接口中 DbObject
    
    参数:
    
    forTable - the new table
    
    quotedName - the quoted name
    
    返回:
    
    the SQL statement
  - getDropSQL
```
public String getDropSQL()
```
    从接口复制的说明: DbObject
    
    Construct a DROP ... SQL statement for this object.
    
    指定者:
    
    getDropSQL 在接口中 DbObject
    
    返回:
    
    the SQL statement
  - getIndexType
```
public IndexType getIndexType()
```
    从接口复制的说明: Index
    
    Get the index type.
    
    指定者:
    
    getIndexType 在接口中 Index
    
    返回:
    
    the index type
  - getPlanSQL
```
public String getPlanSQL()
```
    从接口复制的说明: Index
    
    Get the message to show in a EXPLAIN statement.
    
    指定者:
    
    getPlanSQL 在接口中 Index
    
    返回:
    
    the plan
  - getRowCount
```
public long getRowCount(Session session)
```
    从接口复制的说明: Index
    
    Get the row count of this table, for the given session.
    
    指定者:
    
    getRowCount 在接口中 Index
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - getTable
```
public Table getTable()
```
    从接口复制的说明: Index
    
    Get the table on which this index is based.
    
    指定者:
    
    getTable 在接口中 Index
    
    返回:
    
    the table
  - getType
```
public int getType()
```
    从接口复制的说明: DbObject
    
    Get the object type.
    
    指定者:
    
    getType 在接口中 DbObject
    
    返回:
    
    the object type
  - removeChildrenAndResources
```
public void removeChildrenAndResources(Session session)
```
    从接口复制的说明: DbObject
    
    Delete all dependent children objects and resources of this object.
    
    指定者:
    
    removeChildrenAndResources 在接口中 DbObject
    
    参数:
    
    session - the session
  - getSQL
```
public String getSQL()
```
    从接口复制的说明: DbObject
    
    Get the SQL name of this object (may be quoted).
    
    指定者:
    
    getSQL 在接口中 DbObject
    
    返回:
    
    the SQL name
  - getSchema
```
public Schema getSchema()
```
    从接口复制的说明: SchemaObject
    
    Get the schema in which this object is defined
    
    指定者:
    
    getSchema 在接口中 SchemaObject
    
    返回:
    
    the schema
  - checkRename
```
public void checkRename()
```
    从接口复制的说明: DbObject
    
    Check if renaming is allowed. Does nothing when allowed.
    
    指定者:
    
    checkRename 在接口中 DbObject
  - getChildren
```
public ArrayList<DbObject> getChildren()
```
    从接口复制的说明: DbObject
    
    Get the list of dependent children (for tables, this includes indexes and so on).
    
    指定者:
    
    getChildren 在接口中 DbObject
    
    返回:
    
    the list of children
  - getComment
```
public String getComment()
```
    从接口复制的说明: DbObject
    
    Get the current comment of this object.
    
    指定者:
    
    getComment 在接口中 DbObject
    
    返回:
    
    the comment, or null if not set
  - getDatabase
```
public Database getDatabase()
```
    从接口复制的说明: DbObject
    
    Get the database.
    
    指定者:
    
    getDatabase 在接口中 DbObject
    
    返回:
    
    the database
  - getId
```
public int getId()
```
    从接口复制的说明: DbObject
    
    Get the unique object id.
    
    指定者:
    
    getId 在接口中 DbObject
    
    返回:
    
    the object id
  - getName
```
public String getName()
```
    从接口复制的说明: DbObject
    
    Get the name.
    
    指定者:
    
    getName 在接口中 DbObject
    
    返回:
    
    the name
  - isTemporary
```
public boolean isTemporary()
```
    从接口复制的说明: DbObject
    
    Check if this object is temporary (for example, a temporary table).
    
    指定者:
    
    isTemporary 在接口中 DbObject
    
    返回:
    
    true if is temporary
  - rename
```
public void rename(String newName)
```
    从接口复制的说明: DbObject
    
    Rename the object.
    
    指定者:
    
    rename 在接口中 DbObject
    
    参数:
    
    newName - the new name
  - setComment
```
public void setComment(String comment)
```
    从接口复制的说明: DbObject
    
    Change the comment of this object.
    
    指定者:
    
    setComment 在接口中 DbObject
    
    参数:
    
    comment - the new comment, or null for no comment
  - setTemporary
```
public void setTemporary(boolean temporary)
```
    从接口复制的说明: DbObject
    
    Tell this object that it is temporary or not.
    
    指定者:
    
    setTemporary 在接口中 DbObject
    
    参数:
    
    temporary - the new value
  - getRowCountApproximation
```
public long getRowCountApproximation()
```
    从接口复制的说明: Index
    
    Get the approximated row count for this table.
    
    指定者:
    
    getRowCountApproximation 在接口中 Index
    
    返回:
    
    the approximated row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    从接口复制的说明: Index
    
    Get the used disk space for this index.
    
    指定者:
    
    getDiskSpaceUsed 在接口中 Index
    
    返回:
    
    the estimated number of bytes
  - getBaseIndex
```
public Index getBaseIndex()
```
  - getRow
```
public Row getRow(Session session,
                  long key)
```
    从接口复制的说明: Index
    
    Get the row with the given key.
    
    指定者:
    
    getRow 在接口中 Index
    
    参数:
    
    session - the session
    
    key - the unique key
    
    返回:
    
    the row
  - isHidden
```
public boolean isHidden()
```
    从接口复制的说明: SchemaObject
    
    Check whether this is a hidden object that doesn't appear in the meta data and in the script, and is not dropped on DROP ALL OBJECTS.
    
    指定者:
    
    isHidden 在接口中 SchemaObject
    
    返回:
    
    true if it is hidden
  - isRowIdIndex
```
public boolean isRowIdIndex()
```
    从接口复制的说明: Index
    
    Does this index support lookup by row id?
    
    指定者:
    
    isRowIdIndex 在接口中 Index
    
    返回:
    
    true if it does
  - canScan
```
public boolean canScan()
```
    从接口复制的说明: Index
    
    Can this index iterate over all rows?
    
    指定者:
    
    canScan 在接口中 Index
    
    返回:
    
    true if it can
  - setSortedInsertMode
```
public void setSortedInsertMode(boolean sortedInsertMode)
```
    从接口复制的说明: Index
    
    Enable or disable the 'sorted insert' optimizations (rows are inserted in ascending or descending order) if applicable for this index implementation.
    
    指定者:
    
    setSortedInsertMode 在接口中 Index
    
    参数:
    
    sortedInsertMode - the new value
  - createLookupBatch
```
public IndexLookupBatch createLookupBatch(TableFilter[] filters,
                                          int filter)
```
    从接口复制的说明: Index
    
    Creates new lookup batch. Note that returned IndexLookupBatch instance can be used multiple times.
    
    指定者:
    
    createLookupBatch 在接口中 Index
    
    参数:
    
    filters - the table filters
    
    filter - the filter index (0, 1,...)
    
    返回:
    
    created batch or null if batched lookup is not supported by this index.

类 MultiVersionIndex

字段概要

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

构造器概要

方法概要

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

构造器详细资料

MultiVersionIndex

方法详细资料

add

close

find

find

findNext

canFindNext

canGetFirstOrLast

findFirstOrLast

getCost

needRebuild

isUncommittedFromOtherSession

remove

remove

truncate

commit

compareRows

getColumnIndex

getColumns

getIndexColumns

getCreateSQL

getCreateSQLForCopy

getDropSQL

getIndexType

getPlanSQL

getRowCount

getTable

getType

removeChildrenAndResources

getSQL

getSchema

checkRename

getChildren

getComment

getDatabase

getId

getName

isTemporary

rename

setComment

setTemporary

getRowCountApproximation

getDiskSpaceUsed

getBaseIndex

getRow

isHidden

isRowIdIndex

canScan

setSortedInsertMode

createLookupBatch