MVSecondaryIndex (H2 Database Engine 2.0.0 API)

java.lang.Object
- org.h2.engine.DbObject
- - org.h2.schema.SchemaObject
  - - org.h2.index.Index
    - - org.h2.mvstore.db.MVIndex<SearchRow,Value>
      - org.h2.mvstore.db.MVSecondaryIndex

所有已实现的接口:: HasSQL

public final class MVSecondaryIndex
extends MVIndex<SearchRow,Value>

An index stored in a MVStore.

字段概要
- 从类继承的字段 org.h2.index.Index
  columnIds, columns, indexColumns, indexType, table, uniqueColumnColumn
- 从类继承的字段 org.h2.engine.DbObject
  AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER
- 从接口继承的字段 org.h2.util.HasSQL
  ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

构造器概要

构造器
构造器和说明
`MVSecondaryIndex(Database db, MVTable table, int id, String indexName, IndexColumn[] columns, int uniqueColumnCount, IndexType indexType)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`add(SessionLocal session, Row row)` Add a row to the index.
`void`	`addBufferedRows(List<String> bufferNames)` Add all the index data from the buffers to the index.
`void`	`addRowsToBuffer(List<Row> rows, String bufferName)` Add the rows to a temporary storage (not to the index yet).
`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.
`void`	`close(SessionLocal session)` Close this index.
`Cursor`	`find(SessionLocal session, SearchRow first, SearchRow last)` Find a row or a list of rows and create a cursor to iterate over the result.
`Cursor`	`findFirstOrLast(SessionLocal session, boolean first)` Find the first (or last) value of this index.
`Cursor`	`findNext(SessionLocal session, SearchRow higherThan, SearchRow last)` Find a row or a list of rows that is larger and create a cursor to iterate over the result.
`double`	`getCost(SessionLocal session, int[] masks, TableFilter[] filters, int filter, SortOrder sortOrder, AllColumnsForPlan allColumnsSet)` Estimate the cost to search for rows given the search mask.
`long`	`getDiskSpaceUsed()` Get the used disk space for this index.
`MVMap<SearchRow,VersionedValue<Value>>`	`getMVMap()`
`long`	`getRowCount(SessionLocal session)` Get the row count of this table, for the given session.
`long`	`getRowCountApproximation(SessionLocal session)` Get the approximated row count for this table.
`MVTable`	`getTable()` Get the table on which this index is based.
`boolean`	`needRebuild()` Check if the index needs to be rebuilt.
`void`	`remove(SessionLocal session)` Remove the index.
`void`	`remove(SessionLocal session, Row row)` Remove a row from the index.
`void`	`truncate(SessionLocal session)` Remove all rows from the index.
`void`	`update(SessionLocal session, Row oldRow, Row newRow)` Update index after row change.

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

从类继承的方法 org.h2.engine.DbObject
checkRename, getChildren, getComment, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

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

从接口继承的方法 org.h2.util.HasSQL
getTraceSQL

- 构造器详细资料
  - MVSecondaryIndex
```
public MVSecondaryIndex(Database db,
                        MVTable table,
                        int id,
                        String indexName,
                        IndexColumn[] columns,
                        int uniqueColumnCount,
                        IndexType indexType)
```
- 方法详细资料
  - addRowsToBuffer
```
public void addRowsToBuffer(List<Row> rows,
                            String bufferName)
```
    从类复制的说明: MVIndex
    
    Add the rows to a temporary storage (not to the index yet). The rows are sorted by the index columns. This is to more quickly build the index.
    
    指定者:
    
    addRowsToBuffer 在类中 MVIndex<SearchRow,Value>
    
    参数:
    
    rows - the rows
    
    bufferName - the name of the temporary storage
  - addBufferedRows
```
public void addBufferedRows(List<String> bufferNames)
```
    从类复制的说明: MVIndex
    
    Add all the index data from the buffers to the index. The index will typically use merge sort to add the data more quickly in sorted order.
    
    指定者:
    
    addBufferedRows 在类中 MVIndex<SearchRow,Value>
    
    参数:
    
    bufferNames - the names of the temporary storage
  - close
```
public void close(SessionLocal session)
```
    从类复制的说明: Index
    
    Close this index.
    
    指定者:
    
    close 在类中 Index
    
    参数:
    
    session - the session used to write data
  - add
```
public void add(SessionLocal session,
                Row row)
```
    从类复制的说明: Index
    
    Add a row to the index.
    
    指定者:
    
    add 在类中 Index
    
    参数:
    
    session - the session to use
    
    row - the row to add
  - remove
```
public void remove(SessionLocal session,
                   Row row)
```
    从类复制的说明: Index
    
    Remove a row from the index.
    
    指定者:
    
    remove 在类中 Index
    
    参数:
    
    session - the session
    
    row - the row
  - update
```
public void update(SessionLocal session,
                   Row oldRow,
                   Row newRow)
```
    从类复制的说明: Index
    
    Update index after row change.
    
    覆盖:
    
    update 在类中 Index
    
    参数:
    
    session - the session
    
    oldRow - row before the update
    
    newRow - row after the update
  - find
```
public Cursor find(SessionLocal 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
  - getTable
```
public MVTable getTable()
```
    从类复制的说明: Index
    
    Get the table on which this index is based.
    
    覆盖:
    
    getTable 在类中 Index
    
    返回:
    
    the table
  - getCost
```
public double getCost(SessionLocal session,
                      int[] masks,
                      TableFilter[] filters,
                      int filter,
                      SortOrder sortOrder,
                      AllColumnsForPlan 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
  - remove
```
public void remove(SessionLocal session)
```
    从类复制的说明: Index
    
    Remove the index.
    
    指定者:
    
    remove 在类中 Index
    
    参数:
    
    session - the session
  - truncate
```
public void truncate(SessionLocal session)
```
    从类复制的说明: Index
    
    Remove all rows from the index.
    
    指定者:
    
    truncate 在类中 Index
    
    参数:
    
    session - the session
  - 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(SessionLocal 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)
  - 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.
  - getRowCount
```
public long getRowCount(SessionLocal session)
```
    从类复制的说明: Index
    
    Get the row count of this table, for the given session.
    
    指定者:
    
    getRowCount 在类中 Index
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - getRowCountApproximation
```
public long getRowCountApproximation(SessionLocal session)
```
    从类复制的说明: Index
    
    Get the approximated row count for this table.
    
    指定者:
    
    getRowCountApproximation 在类中 Index
    
    参数:
    
    session - the session
    
    返回:
    
    the approximated row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    从类复制的说明: Index
    
    Get the used disk space for this index.
    
    覆盖:
    
    getDiskSpaceUsed 在类中 Index
    
    返回:
    
    the estimated number of bytes
  - canFindNext
```
public boolean canFindNext()
```
    从类复制的说明: Index
    
    Check if the index can get the next higher value.
    
    覆盖:
    
    canFindNext 在类中 Index
    
    返回:
    
    true if it can
  - findNext
```
public Cursor findNext(SessionLocal session,
                       SearchRow higherThan,
                       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
    
    higherThan - the lower limit (excluding)
    
    last - the last row, or null for no limit
    
    返回:
    
    the cursor
  - getMVMap
```
public MVMap<SearchRow,VersionedValue<Value>> getMVMap()
```
    指定者:
    
    getMVMap 在类中 MVIndex<SearchRow,Value>

类 MVSecondaryIndex

字段概要

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

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

从接口继承的字段 org.h2.util.HasSQL

构造器概要

方法概要

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

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

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

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

从接口继承的方法 org.h2.util.HasSQL

构造器详细资料

MVSecondaryIndex

方法详细资料

addRowsToBuffer

addBufferedRows

close

add

remove

update

find

getTable

getCost

remove

truncate

canGetFirstOrLast

findFirstOrLast

needRebuild

getRowCount

getRowCountApproximation

getDiskSpaceUsed

canFindNext

findNext

getMVMap