BaseIndex (H2 Database Engine wt-1.0.1 API)

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

所有已实现的接口:

DbObject, Index, SchemaObject

直接已知子类:

FunctionIndex, HashIndex, LinkedIndex, MetaIndex, MVDelegateIndex, MVPrimaryIndex, MVSecondaryIndex, MVSpatialIndex, NonUniqueHashIndex, PageIndex, RangeIndex, ScanIndex, SpatialTreeIndex, TreeIndex, ViewIndex
```
public abstract class BaseIndex
extends SchemaObjectBase
implements Index
```
Most index implementations extend the base index.

字段概要

字段
限定符和类型	字段和说明
`protected int[]`	`columnIds`
`protected Column[]`	`columns`
`protected IndexColumn[]`	`indexColumns`
`protected IndexType`	`indexType`
`protected boolean`	`isMultiVersion`
`protected Table`	`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

构造器概要

构造器
构造器和说明

BaseIndex()

构造器
构造器和说明
`BaseIndex()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`canFindNext()` Check if the index can get the next higher value.
`boolean`	`canScan()` Can this index iterate over all rows?
`protected static void`	`checkIndexColumnTypes(IndexColumn[] columns)` Check that the index columns are not CLOB or BLOB.
`void`	`commit(int operation, Row row)` Commit the operation for a row.
`int`	`compareRows(SearchRow rowData, SearchRow compare)` Compare two rows.
`protected boolean`	`containsNullAndAllowMultipleNull(SearchRow newRow)` Check if one of the columns is NULL and multiple rows with NULL are allowed using the current compatibility mode for unique indexes.
`IndexLookupBatch`	`createLookupBatch(TableFilter[] filters, int filter)` Creates new lookup batch.
`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`	`findNext(Session 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.
`int`	`getColumnIndex(Column col)` Get the index of a column in the list of index columns
`Column[]`	`getColumns()` Get the indexed columns.
`protected long`	`getCostRangeIndex(int[] masks, long rowCount, TableFilter[] filters, int filter, SortOrder sortOrder, boolean isScanIndex, HashSet<Column> allColumnsSet)` Calculate the cost for the given mask as if this index was a typical b-tree range index.
`String`	`getCreateSQL()` Build a SQL statement to re-create this object.
`String`	`getCreateSQLForCopy(Table targetTable, 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
`String`	`getDropSQL()` Build a SQL statement to drop this object.
`protected DbException`	`getDuplicateKeyException(String key)` Create a duplicate key exception with a message that contains the index name.
`IndexColumn[]`	`getIndexColumns()` Get the indexed columns as index columns (with ordering information).
`IndexType`	`getIndexType()` Get the index type.
`String`	`getPlanSQL()` Get the message to show in a EXPLAIN statement.
`Row`	`getRow(Session session, long key)` Get the row with the given key.
`Table`	`getTable()` Get the table on which this index is based.
`int`	`getType()` Get the object type.
`protected void`	`initBaseIndex(Table newTable, int id, String name, IndexColumn[] newIndexColumns, IndexType newIndexType)` Initialize the base index.
`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?
`void`	`removeChildrenAndResources(Session session)` Remove all dependent objects and free all resources (files, blocks in files) 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.

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

从类继承的方法 org.h2.engine.DbObjectBase
checkRename, 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.index.Index
add, canGetFirstOrLast, close, find, findFirstOrLast, getCost, getDiskSpaceUsed, getRowCount, getRowCountApproximation, needRebuild, remove, remove, truncate

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

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

- 字段详细资料
  - indexColumns
```
protected IndexColumn[] indexColumns
```
  - columns
```
protected Column[] columns
```
  - columnIds
```
protected int[] columnIds
```
  - table
```
protected Table table
```
  - indexType
```
protected IndexType indexType
```
  - isMultiVersion
```
protected boolean isMultiVersion
```
- 构造器详细资料
  - BaseIndex
```
public BaseIndex()
```
- 方法详细资料
  - initBaseIndex
```
protected void initBaseIndex(Table newTable,
                             int id,
                             String name,
                             IndexColumn[] newIndexColumns,
                             IndexType newIndexType)
```
    Initialize the base index.
    
    参数:
    
    newTable - the table
    
    id - the object id
    
    name - the index name
    
    newIndexColumns - the columns that are indexed or null if this is not yet known
    
    newIndexType - the index type
  - checkIndexColumnTypes
```
protected static void checkIndexColumnTypes(IndexColumn[] columns)
```
    Check that the index columns are not CLOB or BLOB.
    
    参数:
    
    columns - the columns
  - getDropSQL
```
public String getDropSQL()
```
    从类复制的说明: DbObjectBase
    
    Build a SQL statement to drop this object.
    
    指定者:
    
    getDropSQL 在接口中 DbObject
    
    指定者:
    
    getDropSQL 在类中 DbObjectBase
    
    返回:
    
    the SQL statement
  - getDuplicateKeyException
```
protected DbException getDuplicateKeyException(String key)
```
    Create a duplicate key exception with a message that contains the index name.
    
    参数:
    
    key - the key values
    
    返回:
    
    the exception
  - getPlanSQL
```
public String getPlanSQL()
```
    从接口复制的说明: Index
    
    Get the message to show in a EXPLAIN statement.
    
    指定者:
    
    getPlanSQL 在接口中 Index
    
    返回:
    
    the plan
  - 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 在类中 DbObjectBase
    
    参数:
    
    session - the session
  - canFindNext
```
public boolean canFindNext()
```
    从接口复制的说明: Index
    
    Check if the index can get the next higher value.
    
    指定者:
    
    canFindNext 在接口中 Index
    
    返回:
    
    true if it can
  - 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
  - findNext
```
public Cursor findNext(Session 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. The base implementation doesn't support this feature.
    
    指定者:
    
    findNext 在接口中 Index
    
    参数:
    
    session - the session
    
    higherThan - the lower limit (excluding)
    
    last - the last row, or null for no limit
    
    返回:
    
    the cursor
    
    抛出:
    
    DbException - always
  - getCostRangeIndex
```
protected final long getCostRangeIndex(int[] masks,
                                       long rowCount,
                                       TableFilter[] filters,
                                       int filter,
                                       SortOrder sortOrder,
                                       boolean isScanIndex,
                                       HashSet<Column> allColumnsSet)
```
    Calculate the cost for the given mask as if this index was a typical b-tree range index. This is the estimated cost required to search one row, and then iterate over the given number of rows.
    
    参数:
    
    masks - the IndexCondition search masks, one for each column in the table
    
    rowCount - the number of rows in the index
    
    filters - all joined table filters
    
    filter - the current table filter index
    
    sortOrder - the sort order
    
    isScanIndex - whether this is a "table scan" index
    
    allColumnsSet - the set of all columns
    
    返回:
    
    the estimated cost
  - 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
  - containsNullAndAllowMultipleNull
```
protected boolean containsNullAndAllowMultipleNull(SearchRow newRow)
```
    Check if one of the columns is NULL and multiple rows with NULL are allowed using the current compatibility mode for unique indexes. Note: NULL behavior is complicated in SQL.
    
    参数:
    
    newRow - the row to check
    
    返回:
    
    true if one of the columns is null and multiple nulls in unique indexes are allowed
  - 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)
  - getCreateSQLForCopy
```
public String getCreateSQLForCopy(Table targetTable,
                                  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
    
    参数:
    
    targetTable - the new table
    
    quotedName - the quoted name
    
    返回:
    
    the SQL statement
  - getCreateSQL
```
public String getCreateSQL()
```
    从类复制的说明: DbObjectBase
    
    Build a SQL statement to re-create this object.
    
    指定者:
    
    getCreateSQL 在接口中 DbObject
    
    指定者:
    
    getCreateSQL 在类中 DbObjectBase
    
    返回:
    
    the SQL statement
  - getIndexColumns
```
public IndexColumn[] getIndexColumns()
```
    从接口复制的说明: Index
    
    Get the indexed columns as index columns (with ordering information).
    
    指定者:
    
    getIndexColumns 在接口中 Index
    
    返回:
    
    the index columns
  - getColumns
```
public Column[] getColumns()
```
    从接口复制的说明: Index
    
    Get the indexed columns.
    
    指定者:
    
    getColumns 在接口中 Index
    
    返回:
    
    the columns
  - getIndexType
```
public IndexType getIndexType()
```
    从接口复制的说明: Index
    
    Get the index type.
    
    指定者:
    
    getIndexType 在接口中 Index
    
    返回:
    
    the index type
  - getType
```
public int getType()
```
    从接口复制的说明: DbObject
    
    Get the object type.
    
    指定者:
    
    getType 在接口中 DbObject
    
    返回:
    
    the object type
  - getTable
```
public Table getTable()
```
    从接口复制的说明: Index
    
    Get the table on which this index is based.
    
    指定者:
    
    getTable 在接口中 Index
    
    返回:
    
    the table
  - 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
  - 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
    
    覆盖:
    
    isHidden 在类中 SchemaObjectBase
    
    返回:
    
    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.

类 BaseIndex

字段概要

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

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

构造器概要

方法概要

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

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

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

从接口继承的方法 org.h2.index.Index

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

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

字段详细资料

indexColumns

columns

columnIds

table

indexType

isMultiVersion

构造器详细资料

BaseIndex

方法详细资料

initBaseIndex

checkIndexColumnTypes

getDropSQL

getDuplicateKeyException

getPlanSQL

removeChildrenAndResources

canFindNext

find

findNext

getCostRangeIndex

compareRows

containsNullAndAllowMultipleNull

getColumnIndex

getCreateSQLForCopy

getCreateSQL

getIndexColumns

getColumns

getIndexType

getType

getTable

commit

getRow

isHidden

isRowIdIndex

canScan

setSortedInsertMode

createLookupBatch