org.h2.mvstore.db

Class MVSecondaryIndex

java.lang.Object

org.h2.engine.DbObjectBase

org.h2.schema.SchemaObjectBase

org.h2.index.BaseIndex

org.h2.mvstore.db.MVSecondaryIndex

All Implemented Interfaces:

DbObject, Index, MVIndex, SchemaObject

public final class MVSecondaryIndex
extends BaseIndex
implements MVIndex

A table stored in a MVStore.

Field Summary

Fields inherited from class org.h2.index.BaseIndex

columnIds, columns, indexColumns, indexType, isMultiVersion, table

Fields inherited from class org.h2.engine.DbObjectBase

comment, database, trace

Fields inherited from interface org.h2.engine.DbObject

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

Constructor Summary

Constructors

Constructor and Description
MVSecondaryIndex(Database db, MVTable table, int id, java.lang.String indexName, IndexColumn[] columns, IndexType indexType)

Method Summary

Modifier and Type	Method and Description
void	add(Session session, Row row) Add a row to the index.
void	addBufferedRows(java.util.List<java.lang.String> bufferNames) Add all the index data from the buffers to the index.
void	addRowsToBuffer(java.util.List<Row> rows, java.lang.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	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.
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.
double	getCost(Session session, int[] masks, TableFilter[] filters, int filter, SortOrder sortOrder, java.util.HashSet<Column> allColumnsSet) Estimate the cost to search for rows given the search mask.
long	getDiskSpaceUsed() Get the used disk space for this index.
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.
MVTable	getTable() Get the table on which this index is based.
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.

Methods inherited from class org.h2.index.BaseIndex

canScan, checkIndexColumnTypes, commit, compareRows, createLookupBatch, find, getColumnIndex, getColumns, getCostRangeIndex, getCreateSQL, getCreateSQLForCopy, getDropSQL, getDuplicateKeyException, getIndexColumns, getIndexType, getPlanSQL, getRow, getType, initBaseIndex, isFindUsingFullTableScan, isFirstColumn, isHidden, isRowIdIndex, mayHaveNullDuplicates, removeChildrenAndResources, setSortedInsertMode

Methods inherited from class org.h2.schema.SchemaObjectBase

getSchema, getSQL, initSchemaObjectBase

Methods inherited from class org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, 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.index.Index

canScan, commit, compareRows, createLookupBatch, find, getColumnIndex, getColumns, getIndexColumns, getIndexType, getPlanSQL, getRow, isFindUsingFullTableScan, isFirstColumn, isRowIdIndex, setSortedInsertMode

Methods inherited from interface org.h2.schema.SchemaObject

getSchema, isHidden

Methods inherited from interface org.h2.engine.DbObject

getChildren, getComment, getCreateSQL, getCreateSQLForCopy, getDatabase, getDropSQL, getId, getName, getSQL, getType, isTemporary, removeChildrenAndResources, rename, setComment, setTemporary

Constructor Detail

MVSecondaryIndex

public MVSecondaryIndex(Database db,
                        MVTable table,
                        int id,
                        java.lang.String indexName,
                        IndexColumn[] columns,
                        IndexType indexType)

Method Detail

addRowsToBuffer

public void addRowsToBuffer(java.util.List<Row> rows,
                            java.lang.String bufferName)

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

Specified by:

addRowsToBuffer in interface MVIndex

Parameters:

rows - the rows

bufferName - the name of the temporary storage

addBufferedRows

public void addBufferedRows(java.util.List<java.lang.String> bufferNames)

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

Specified by:

addBufferedRows in interface MVIndex

Parameters:

bufferNames - the names of the temporary storage

close

public void close(Session session)

Description copied from interface: Index

Close this index.

Specified by:

close in interface Index

Parameters:

session - the session used to write data

add

public void add(Session session,
                Row row)

Description copied from interface: Index

Add a row to the index.

Specified by:

add in interface Index

Parameters:

session - the session to use

row - the row to add

remove

public void remove(Session session,
                   Row row)

Description copied from interface: Index

Remove a row from the index.

Specified by:

remove in interface Index

Parameters:

session - the session

row - the row

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.

Specified by:

find in interface Index

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

getTable

public MVTable getTable()

Description copied from interface: Index

Get the table on which this index is based.

Specified by:

getTable in interface Index

Overrides:

getTable in class BaseIndex

Returns:

the table

getCost

public double getCost(Session session,
                      int[] masks,
                      TableFilter[] filters,
                      int filter,
                      SortOrder sortOrder,
                      java.util.HashSet<Column> 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.

Specified by:

getCost in interface Index

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

remove

public void remove(Session session)

Description copied from interface: Index

Remove the index.

Specified by:

remove in interface Index

Parameters:

session - the session

truncate

public void truncate(Session session)

Description copied from interface: Index

Remove all rows from the index.

Specified by:

truncate in interface Index

Parameters:

session - the session

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.

Specified by:

canGetFirstOrLast in interface Index

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

Parameters:

session - the session

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

Returns:

a cursor (never null)

needRebuild

public boolean needRebuild()

Description copied from interface: Index

Check if the index needs to be rebuilt. This method is called after opening an index.

Specified by:

needRebuild in interface Index

Returns:

true if a rebuild is required.

getRowCount

public long getRowCount(Session session)

Description copied from interface: Index

Get the row count of this table, for the given session.

Specified by:

getRowCount in interface Index

Parameters:

session - the session

Returns:

the row count

getRowCountApproximation

public long getRowCountApproximation()

Description copied from interface: Index

Get the approximated row count for this table.

Specified by:

getRowCountApproximation in interface Index

Returns:

the approximated row count

getDiskSpaceUsed

public long getDiskSpaceUsed()

Description copied from interface: Index

Get the used disk space for this index.

Specified by:

getDiskSpaceUsed in interface Index

Returns:

the estimated number of bytes

canFindNext

public boolean canFindNext()

Description copied from interface: Index

Check if the index can get the next higher value.

Specified by:

canFindNext in interface Index

Overrides:

canFindNext in class BaseIndex

Returns:

true if it can

findNext

public Cursor findNext(Session session,
                       SearchRow higherThan,
                       SearchRow last)

Description copied from class: BaseIndex

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.

Specified by:

findNext in interface Index

Overrides:

findNext in class BaseIndex

Parameters:

session - the session

higherThan - the lower limit (excluding)

last - the last row, or null for no limit

Returns:

the cursor

checkRename

public void checkRename()

Description copied from class: DbObjectBase

Check if this object can be renamed. System objects may not be renamed.

Specified by:

checkRename in interface DbObject

Specified by:

checkRename in class DbObjectBase