org.h2.index

Class RangeIndex

java.lang.Object

org.h2.engine.DbObjectBase

org.h2.schema.SchemaObjectBase

org.h2.index.BaseIndex

org.h2.index.VirtualTableIndex

org.h2.index.RangeIndex

All Implemented Interfaces:

DbObject, Index, SchemaObject

public class RangeIndex
extends VirtualTableIndex

An index for the SYSTEM_RANGE table. This index can only scan through all rows, search is not supported.

Field Summary

Fields inherited from class org.h2.index.BaseIndex

columnIds, columns, indexColumns, indexType, table

Fields inherited from class org.h2.engine.DbObjectBase

comment, database, trace

Fields inherited from interface org.h2.engine.DbObject

AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, TRIGGER, USER

Constructor Summary

Constructors

Constructor and Description
RangeIndex(RangeTable table, IndexColumn[] columns)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGetFirstOrLast() Check if the index can directly look up the lowest or highest value of a column.
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, AllColumnsForPlan allColumnsSet) Estimate the cost to search for rows given the search mask.
java.lang.String	getCreateSQL() Build a SQL statement to re-create this object.
java.lang.String	getPlanSQL() Get the message to show in a EXPLAIN statement.

Methods inherited from class org.h2.index.VirtualTableIndex

add, checkRename, close, getDiskSpaceUsed, getRowCount, getRowCountApproximation, needRebuild, remove, remove, truncate

Methods inherited from class org.h2.index.BaseIndex

canFindNext, canScan, checkIndexColumnTypes, compareKeys, compareRows, createLookupBatch, find, findNext, getColumnIndex, getColumns, getCostRangeIndex, getCreateSQLForCopy, getDropSQL, getDuplicateKeyException, getDuplicatePrimaryKeyMessage, getIndexColumns, getIndexType, getRow, getTable, getType, isFindUsingFullTableScan, isFirstColumn, isHidden, isRowIdIndex, mayHaveNullDuplicates, removeChildrenAndResources, setSortedInsertMode, update

Methods inherited from class org.h2.schema.SchemaObjectBase

getSchema, getSQL, getSQL

Methods inherited from class org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, getId, getModificationId, getName, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.h2.schema.SchemaObject

getSchema

Methods inherited from interface org.h2.engine.DbObject

getChildren, getComment, getDatabase, getId, getName, getSQL, getSQL, isTemporary, rename, setComment, setTemporary

Constructor Detail

RangeIndex

public RangeIndex(RangeTable table,
          IndexColumn[] columns)

Method Detail

find

public Cursor find(Session session,
          SearchRow first,
          SearchRow last)

Description copied from interface: Index

Find a row or a list of rows and create a cursor to iterate over the result.

Parameters:

session - the session

first - the first row, or null for no limit

last - the last row, or null for no limit

Returns:

the cursor to iterate over the results

getCost

public double getCost(Session session,
             int[] masks,
             TableFilter[] filters,
             int filter,
             SortOrder sortOrder,
             AllColumnsForPlan allColumnsSet)

Description copied from interface: 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.

Parameters:

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

Returns:

the estimated cost

getCreateSQL

public java.lang.String getCreateSQL()

Description copied from class: DbObjectBase

Build a SQL statement to re-create this object.

Specified by:

getCreateSQL in interface DbObject

Overrides:

getCreateSQL in class BaseIndex

Returns:

the SQL statement

canGetFirstOrLast

public boolean canGetFirstOrLast()

Description copied from interface: Index

Check if the index can directly look up the lowest or highest value of a column.

Returns:

true if it can

findFirstOrLast

public Cursor findFirstOrLast(Session session,
                     boolean first)

Description copied from interface: 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.

Specified by:

findFirstOrLast in interface Index

Overrides:

findFirstOrLast in class VirtualTableIndex

Parameters:

session - the session

first - true if the first (lowest for ascending indexes) or last value should be returned

Returns:

a cursor (never null)

getPlanSQL

public java.lang.String getPlanSQL()

Description copied from interface: Index

Get the message to show in a EXPLAIN statement.

Specified by:

getPlanSQL in interface Index

Overrides:

getPlanSQL in class BaseIndex

Returns:

the plan