FunctionIndex (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.FunctionIndex

所有已实现的接口:

DbObject, Index, SchemaObject
```
public class FunctionIndex
extends BaseIndex
```
An index for a function that returns a result set. This index can only scan through all rows, search is not supported.

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

构造器概要

构造器
构造器和说明

FunctionIndex(FunctionTable functionTable, IndexColumn[] columns)

构造器
构造器和说明
`FunctionIndex(FunctionTable functionTable, IndexColumn[] columns)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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.
`boolean`	`canScan()` Can this index iterate over all rows?
`void`	`checkRename()` Check if this object can be renamed.
`void`	`close(Session session)` Close this index.
`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.
`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.
`long`	`getDiskSpaceUsed()` Get the used disk space for this index.
`String`	`getPlanSQL()` Get the message to show in a EXPLAIN statement.
`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.
`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`	`truncate(Session session)` Remove all rows from the index.

从类继承的方法 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, toString

从类继承的方法 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

- 构造器详细资料
  - FunctionIndex
```
public FunctionIndex(FunctionTable functionTable,
                     IndexColumn[] columns)
```
- 方法详细资料
  - close
```
public void close(Session session)
```
    从接口复制的说明: Index
    
    Close this index.
    
    参数:
    
    session - the session used to write data
  - 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
  - remove
```
public void remove(Session session,
                   Row row)
```
    从接口复制的说明: Index
    
    Remove a row from the index.
    
    参数:
    
    session - the session
    
    row - the row
  - 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
  - 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
  - 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
  - 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.
  - checkRename
```
public void checkRename()
```
    从类复制的说明: DbObjectBase
    
    Check if this object can be renamed. System objects may not be renamed.
    
    指定者:
    
    checkRename 在接口中 DbObject
    
    指定者:
    
    checkRename 在类中 DbObjectBase
  - 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
  - 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)
  - getRowCount
```
public long getRowCount(Session session)
```
    从接口复制的说明: Index
    
    Get the row count of this table, for the given session.
    
    参数:
    
    session - the session
    
    返回:
    
    the row count
  - getRowCountApproximation
```
public long getRowCountApproximation()
```
    从接口复制的说明: Index
    
    Get the approximated row count for this table.
    
    返回:
    
    the approximated row count
  - getDiskSpaceUsed
```
public long getDiskSpaceUsed()
```
    从接口复制的说明: Index
    
    Get the used disk space for this index.
    
    返回:
    
    the estimated number of bytes
  - getPlanSQL
```
public String getPlanSQL()
```
    从接口复制的说明: Index
    
    Get the message to show in a EXPLAIN statement.
    
    指定者:
    
    getPlanSQL 在接口中 Index
    
    覆盖:
    
    getPlanSQL 在类中 BaseIndex
    
    返回:
    
    the plan
  - canScan
```
public boolean canScan()
```
    从接口复制的说明: Index
    
    Can this index iterate over all rows?
    
    指定者:
    
    canScan 在接口中 Index
    
    覆盖:
    
    canScan 在类中 BaseIndex
    
    返回:
    
    true if it can

类 FunctionIndex

字段概要

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

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

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

构造器概要

方法概要

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

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

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

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

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

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

构造器详细资料

FunctionIndex

方法详细资料

close

add

remove

find

getCost

remove

truncate

needRebuild

checkRename

canGetFirstOrLast

findFirstOrLast

getRowCount

getRowCountApproximation

getDiskSpaceUsed

getPlanSQL

canScan