org.h2.index

Class PageDataIndex

java.lang.Object

org.h2.engine.DbObjectBase

org.h2.schema.SchemaObjectBase

org.h2.index.BaseIndex

org.h2.index.PageIndex

org.h2.index.PageDataIndex

All Implemented Interfaces:

DbObject, Index, SchemaObject

public class PageDataIndex
extends PageIndex

The scan index allows to access a row by key. It can be used to iterate over all rows of a table. Each regular table has one such object, even if no primary key or indexes are defined.

Field Summary

Fields inherited from class org.h2.index.PageIndex

rootPageId

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
PageDataIndex(RegularTable table, int id, IndexColumn[] columns, IndexType indexType, boolean create, Session session)

Method Summary

Modifier and Type	Method and Description
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.
void	checkRename() Check if this object can be renamed.
void	close(Session session) Close this index.
void	commit(int operation, Row row) Commit the operation for a row.
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.
int	getColumnIndex(Column col) Get the index of a column in the list of index columns
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.
java.lang.String	getCreateSQL() Build a SQL statement to re-create this object.
long	getDiskSpaceUsed() Get the used disk space for this index.
DbException	getDuplicateKeyException(java.lang.String key) Create a duplicate key exception with a message that contains the index name.
int	getMainIndexColumn()
DbException	getNewDuplicateKeyException()
java.lang.String	getPlanSQL() Get the message to show in a EXPLAIN statement.
Row	getRow(Session session, long key) Get the row with the given key.
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.
Row	getRowWithKey(long key) Get the row with the given key.
boolean	isFirstColumn(Column column) Check if the given column is the first for this index
boolean	isRowIdIndex() Does this index support lookup by row id?
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	setMainIndexColumn(int mainIndexColumn)
java.lang.String	toString()
void	truncate(Session session) Remove all rows from the index.
void	writeRowCount() Write back the row count if it has changed.

Methods inherited from class org.h2.index.PageIndex

getRootPageId, setSortedInsertMode

Methods inherited from class org.h2.index.BaseIndex

canFindNext, canScan, checkIndexColumnTypes, compareRows, createLookupBatch, find, findNext, getColumns, getCostRangeIndex, getCreateSQLForCopy, getDropSQL, getIndexColumns, getIndexType, getTable, getType, initBaseIndex, isFindUsingFullTableScan, isHidden, mayHaveNullDuplicates, removeChildrenAndResources

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

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, isTemporary, rename, setComment, setTemporary

Constructor Detail

PageDataIndex

public PageDataIndex(RegularTable table,
                     int id,
                     IndexColumn[] columns,
                     IndexType indexType,
                     boolean create,
                     Session session)

Method Detail

getDuplicateKeyException

public DbException getDuplicateKeyException(java.lang.String key)

Description copied from class: BaseIndex

Create a duplicate key exception with a message that contains the index name.

Overrides:

getDuplicateKeyException in class BaseIndex

Parameters:

key - the key values

Returns:

the exception

add

public void add(Session session,
                Row row)

Description copied from interface: Index

Add a row to the index.

Parameters:

session - the session to use

row - the row to add

getNewDuplicateKeyException

public DbException getNewDuplicateKeyException()

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

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

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.

Parameters:

session - the session

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

Returns:

a cursor (never null)

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.

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

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.

Returns:

true if a rebuild is required.

remove

public void remove(Session session,
                   Row row)

Description copied from interface: Index

Remove a row from the index.

Parameters:

session - the session

row - the row

remove

public void remove(Session session)

Description copied from interface: Index

Remove the index.

Parameters:

session - the session

truncate

public void truncate(Session session)

Description copied from interface: Index

Remove all rows from the index.

Parameters:

session - the session

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

getRow

public Row getRow(Session session,
                  long key)

Description copied from interface: Index

Get the row with the given key.

Specified by:

getRow in interface Index

Overrides:

getRow in class BaseIndex

Parameters:

session - the session

key - the unique key

Returns:

the row

getRowWithKey

public Row getRowWithKey(long key)

Get the row with the given key.

Parameters:

key - the key

Returns:

the row

getRowCountApproximation

public long getRowCountApproximation()

Description copied from interface: Index

Get the approximated row count for this table.

Returns:

the approximated row count

getRowCount

public long getRowCount(Session session)

Description copied from interface: Index

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

Parameters:

session - the session

Returns:

the row count

getDiskSpaceUsed

public long getDiskSpaceUsed()

Description copied from interface: Index

Get the used disk space for this index.

Returns:

the estimated number of bytes

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

getColumnIndex

public int getColumnIndex(Column col)

Description copied from interface: Index

Get the index of a column in the list of index columns

Specified by:

getColumnIndex in interface Index

Overrides:

getColumnIndex in class BaseIndex

Parameters:

col - the column

Returns:

the index (0 meaning first column)

isFirstColumn

public boolean isFirstColumn(Column column)

Description copied from interface: Index

Check if the given column is the first for this index

Specified by:

isFirstColumn in interface Index

Overrides:

isFirstColumn in class BaseIndex

Parameters:

column - the column

Returns:

true if the given columns is the first

close

public void close(Session session)

Description copied from interface: Index

Close this index.

Parameters:

session - the session used to write data

commit

public void commit(int operation,
                   Row row)

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

Specified by:

commit in interface Index

Overrides:

commit in class BaseIndex

Parameters:

operation - the operation type

row - the row

setMainIndexColumn

public void setMainIndexColumn(int mainIndexColumn)

getMainIndexColumn

public int getMainIndexColumn()

toString

public java.lang.String toString()

Overrides:

toString in class DbObjectBase

writeRowCount

public void writeRowCount()

Description copied from class: PageIndex

Write back the row count if it has changed.

Specified by:

writeRowCount in class PageIndex

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

isRowIdIndex

public boolean isRowIdIndex()

Description copied from interface: Index

Does this index support lookup by row id?

Specified by:

isRowIdIndex in interface Index

Overrides:

isRowIdIndex in class BaseIndex

Returns:

true if it does