Package org.apache.cassandra.index.sai.disk

Class EmptyIndex

java.lang.Object

org.apache.cassandra.index.sai.disk.SSTableIndex

org.apache.cassandra.index.sai.disk.EmptyIndex

All Implemented Interfaces:

Comparable<SSTableIndex>

public class EmptyIndex
extends SSTableIndex

A placeholder index for when there is no on-disk index. Currenly only used by vector indexes becasue ANN queries require a complete view of the table's sstables, even if the associated sstable does not have any data indexed for the column.

Field Summary

Fields inherited from class org.apache.cassandra.index.sai.disk.SSTableIndex

COMPARATOR, indexIdentifier, indexTermType, sstableContext

Constructor Summary

Constructors

Constructor	Description
EmptyIndex(SSTableContext sstableContext, StorageAttachedIndex index)

Method Summary

Modifier and Type	Method	Description
AbstractBounds<PartitionPosition>	bounds()	Returns the key bounds of the index.
long	getRowCount()	Returns the number of indexed rows in the index.
long	indexFileCacheSize()	Returns the amount of memory occupied by the index when it is initially loaded.
protected void	internalRelease()
long	maxSSTableRowId()	Returns the maximum indexed rowId for the index.
ByteBuffer	maxTerm()	Returns the maximum term held in the index based on the natural sort order of the index column type comparator.
long	minSSTableRowId()	Returns the minimum indexed rowId for the index.
ByteBuffer	minTerm()	Returns the minimum term held in the index based on the natural sort order of the index column type comparator.
List<CloseableIterator<PrimaryKeyWithScore>>	orderBy(Expression orderer, AbstractBounds<PartitionPosition> keyRange, QueryContext context)
List<CloseableIterator<PrimaryKeyWithScore>>	orderResultsBy(QueryContext context, List<PrimaryKey> results, Expression orderer)
void	populateSegmentView(SimpleDataSet dataSet)	Populates a virtual table using the index metadata owned by the index
List<KeyRangeIterator>	search(Expression expression, AbstractBounds<PartitionPosition> keyRange, QueryContext context)	Perform a search on the index for a single expression and keyRange.

Methods inherited from class org.apache.cassandra.index.sai.disk.SSTableIndex

compareTo, equals, getIndexIdentifier, getIndexTermType, getSSTable, getSSTableContext, getVersion, hashCode, isReleased, markObsolete, reference, release, releaseQuietly, sizeOfPerColumnComponents, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EmptyIndex

public EmptyIndex(SSTableContext sstableContext,
 StorageAttachedIndex index)

Method Details

indexFileCacheSize

public long indexFileCacheSize()

Description copied from class: SSTableIndex

Returns the amount of memory occupied by the index when it is initially loaded. This is the amount of data loaded into internal memory buffers by the index and does include the class footprint overhead. It used by the index metrics.

Specified by:

indexFileCacheSize in class SSTableIndex

getRowCount

public long getRowCount()

Description copied from class: SSTableIndex

Returns the number of indexed rows in the index. This comes from the index metadata created when the index was written and is used by the index metrics.

Specified by:

getRowCount in class SSTableIndex

minSSTableRowId

public long minSSTableRowId()

Description copied from class: SSTableIndex

Returns the minimum indexed rowId for the index. This comes from the index metadata created when the index was written and is used by the index metrics.

Specified by:

minSSTableRowId in class SSTableIndex

maxSSTableRowId

public long maxSSTableRowId()

Description copied from class: SSTableIndex

Returns the maximum indexed rowId for the index. This comes from the index metadata created when the index was written and is used by the index metrics.

Specified by:

maxSSTableRowId in class SSTableIndex

minTerm

public ByteBuffer minTerm()

Description copied from class: SSTableIndex

Returns the minimum term held in the index based on the natural sort order of the index column type comparator. It comes from the index metadata created when the index was written and is used by the index metrics and used in queries to determine whether a term, or range or terms, exists in the index.

Specified by:

minTerm in class SSTableIndex

maxTerm

public ByteBuffer maxTerm()

Description copied from class: SSTableIndex

Returns the maximum term held in the index based on the natural sort order of the index column type comparator. It comes from the index metadata created when the index was written and is used by the index metrics and used in queries to determine whether a term, or range or terms, exists in the index.

Specified by:

maxTerm in class SSTableIndex

bounds

public AbstractBounds<PartitionPosition> bounds()

Description copied from class: SSTableIndex

Returns the key bounds of the index. It is created from the minimum and maximum keys held in the metadata and is used to determine whether sstable indexes overlap or not.

Specified by:

bounds in class SSTableIndex

search

public List<KeyRangeIterator> search(Expression expression,
 AbstractBounds<PartitionPosition> keyRange,
 QueryContext context)
                              throws IOException

Description copied from class: SSTableIndex

Perform a search on the index for a single expression and keyRange.

The result is a List of KeyRangeIterator because there will be a KeyRangeIterator for each segment in the index. The result will never be null but may be an empty List.

Specified by:

search in class SSTableIndex

Parameters:

expression - The Expression to be searched for

keyRange - The AbstractBounds<PartitionPosition> defining the token range for the search

context - The QueryContext holding the per-query state

Returns:

a List of KeyRangeIterators containing the results of the search

Throws:

IOException

orderBy

public List<CloseableIterator<PrimaryKeyWithScore>> orderBy(Expression orderer,
 AbstractBounds<PartitionPosition> keyRange,
 QueryContext context)
                                                     throws IOException

Specified by:

orderBy in class SSTableIndex

Throws:

IOException

orderResultsBy

public List<CloseableIterator<PrimaryKeyWithScore>> orderResultsBy(QueryContext context,
 List<PrimaryKey> results,
 Expression orderer)
                                                            throws IOException

Specified by:

orderResultsBy in class SSTableIndex

Throws:

IOException

populateSegmentView

public void populateSegmentView(SimpleDataSet dataSet)

Description copied from class: SSTableIndex

Populates a virtual table using the index metadata owned by the index

Specified by:

populateSegmentView in class SSTableIndex

internalRelease

protected void internalRelease()

Specified by:

internalRelease in class SSTableIndex