public abstract class BaseIndex extends SchemaObjectBase implements Index
| Modifier and Type | Field and Description |
|---|---|
protected int[] |
columnIds |
protected Column[] |
columns |
protected IndexColumn[] |
indexColumns |
protected IndexType |
indexType |
protected boolean |
isMultiVersion |
protected Table |
table |
comment, database, traceAGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE| Constructor and Description |
|---|
BaseIndex() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
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,
java.util.HashSet<Column> allColumnsSet)
Calculate the cost for the given mask as if this index was a typical
b-tree range index.
|
java.lang.String |
getCreateSQL()
Build a SQL statement to re-create this object.
|
java.lang.String |
getCreateSQLForCopy(Table targetTable,
java.lang.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
|
java.lang.String |
getDropSQL()
Build a SQL statement to drop this object.
|
protected DbException |
getDuplicateKeyException(java.lang.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.
|
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.
|
Table |
getTable()
Get the table on which this index is based.
|
int |
getType()
Get the object type.
|
protected void |
initBaseIndex(Table newTable,
int id,
java.lang.String name,
IndexColumn[] newIndexColumns,
IndexType newIndexType)
Initialize the base index.
|
boolean |
isFindUsingFullTableScan()
Returns
true if find() implementation performs scan over all
index, false if find() performs the fast lookup. |
boolean |
isFirstColumn(Column column)
Check if the given column is the first for this 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?
|
protected boolean |
mayHaveNullDuplicates(SearchRow searchRow)
Check if this row may have duplicates with the same indexed values in the
current compatibility mode.
|
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.
|
getSchema, getSQL, initSchemaObjectBasecheckRename, getChildren, getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitadd, canGetFirstOrLast, close, find, findFirstOrLast, getCost, getDiskSpaceUsed, getRowCount, getRowCountApproximation, needRebuild, remove, remove, truncategetSchemacheckRename, getChildren, getComment, getDatabase, getId, getName, getSQL, isTemporary, rename, setComment, setTemporaryprotected IndexColumn[] indexColumns
protected Column[] columns
protected int[] columnIds
protected Table table
protected IndexType indexType
protected boolean isMultiVersion
protected void initBaseIndex(Table newTable, int id, java.lang.String name, IndexColumn[] newIndexColumns, IndexType newIndexType)
newTable - the tableid - the object idname - the index namenewIndexColumns - the columns that are indexed or null if this is
not yet knownnewIndexType - the index typeprotected static void checkIndexColumnTypes(IndexColumn[] columns)
columns - the columnspublic java.lang.String getDropSQL()
DbObjectBasegetDropSQL in interface DbObjectgetDropSQL in class DbObjectBaseprotected DbException getDuplicateKeyException(java.lang.String key)
key - the key valuespublic java.lang.String getPlanSQL()
IndexgetPlanSQL in interface Indexpublic void removeChildrenAndResources(Session session)
DbObjectBaseremoveChildrenAndResources in interface DbObjectremoveChildrenAndResources in class DbObjectBasesession - the sessionpublic boolean canFindNext()
IndexcanFindNext in interface Indexpublic boolean isFindUsingFullTableScan()
Indextrue if find() implementation performs scan over all
index, false if find() performs the fast lookup.isFindUsingFullTableScan in interface Indextrue if find() implementation performs scan over all
index, false if find() performs the fast lookuppublic Cursor find(TableFilter filter, SearchRow first, SearchRow last)
Indexpublic Cursor findNext(Session session, SearchRow higherThan, SearchRow last)
findNext in interface Indexsession - the sessionhigherThan - the lower limit (excluding)last - the last row, or null for no limitDbException - alwaysprotected final long getCostRangeIndex(int[] masks,
long rowCount,
TableFilter[] filters,
int filter,
SortOrder sortOrder,
boolean isScanIndex,
java.util.HashSet<Column> allColumnsSet)
masks - the IndexCondition search masks, one for each column in the
tablerowCount - the number of rows in the indexfilters - all joined table filtersfilter - the current table filter indexsortOrder - the sort orderisScanIndex - whether this is a "table scan" indexallColumnsSet - the set of all columnspublic int compareRows(SearchRow rowData, SearchRow compare)
IndexcompareRows in interface IndexrowData - the first rowcompare - the second rowprotected boolean mayHaveNullDuplicates(SearchRow searchRow)
NULL values are
allowed in some modes.searchRow - the row to checktrue if specified row may have duplicates,
false otherwisepublic int getColumnIndex(Column col)
IndexgetColumnIndex in interface Indexcol - the columnpublic boolean isFirstColumn(Column column)
IndexisFirstColumn in interface Indexcolumn - the columnpublic java.lang.String getCreateSQLForCopy(Table targetTable, java.lang.String quotedName)
DbObjectgetCreateSQLForCopy in interface DbObjecttargetTable - the new tablequotedName - the quoted namepublic java.lang.String getCreateSQL()
DbObjectBasegetCreateSQL in interface DbObjectgetCreateSQL in class DbObjectBasepublic IndexColumn[] getIndexColumns()
IndexgetIndexColumns in interface Indexpublic Column[] getColumns()
IndexgetColumns in interface Indexpublic IndexType getIndexType()
IndexgetIndexType in interface Indexpublic int getType()
DbObjectpublic Table getTable()
Indexpublic void commit(int operation,
Row row)
Indexpublic Row getRow(Session session, long key)
Indexpublic boolean isHidden()
SchemaObjectisHidden in interface SchemaObjectisHidden in class SchemaObjectBasepublic boolean isRowIdIndex()
IndexisRowIdIndex in interface Indexpublic boolean canScan()
Indexpublic void setSortedInsertMode(boolean sortedInsertMode)
IndexsetSortedInsertMode in interface IndexsortedInsertMode - the new valuepublic IndexLookupBatch createLookupBatch(TableFilter[] filters, int filter)
IndexIndexLookupBatch
instance can be used multiple times.createLookupBatch in interface Indexfilters - the table filtersfilter - the filter index (0, 1,...)null if batched lookup is not supported
by this index.