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

Class VectorIndexSegmentSearcher

java.lang.Object

org.apache.cassandra.index.sai.disk.v1.segment.IndexSegmentSearcher

org.apache.cassandra.index.sai.disk.v1.segment.VectorIndexSegmentSearcher

All Implemented Interfaces:

Closeable, AutoCloseable, SegmentOrdering

public class VectorIndexSegmentSearcher
extends IndexSegmentSearcher

Executes ANN search against a vector graph for an individual index segment.

Field Summary

Fields

Modifier and Type	Field	Description
static Boolean	FORCE_BRUTE_FORCE_ANN

Method Summary

Modifier and Type	Method	Description
void	close()
long	indexFileCacheSize()
CloseableIterator<PrimaryKeyWithScore>	orderBy(Expression orderer, AbstractBounds<PartitionPosition> keyRange, QueryContext context)	Order the rows by the given expression.
CloseableIterator<PrimaryKeyWithScore>	orderResultsBy(QueryContext context, List<PrimaryKey> results, Expression orderer)	Reorder, limit, and put back into original order the results from a single sstable
KeyRangeIterator	search(Expression expression, AbstractBounds<PartitionPosition> keyRange, QueryContext queryContext)	Search on-disk index synchronously.
String	toString()

Methods inherited from class org.apache.cassandra.index.sai.disk.v1.segment.IndexSegmentSearcher

open

Methods inherited from class java.lang.Object

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

Field Details

FORCE_BRUTE_FORCE_ANN

public static Boolean FORCE_BRUTE_FORCE_ANN

Method Details

indexFileCacheSize

public long indexFileCacheSize()

Specified by:

indexFileCacheSize in class IndexSegmentSearcher

Returns:

memory usage of underlying on-disk data structure

search

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

Description copied from class: IndexSegmentSearcher

Search on-disk index synchronously.

Specified by:

search in class IndexSegmentSearcher

Parameters:

expression - to filter on disk index

queryContext - to track per sstable cache and per query metrics

Returns:

KeyRangeIterator with matches for the given expression

Throws:

IOException

orderBy

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

Description copied from class: IndexSegmentSearcher

Order the rows by the given expression.

Overrides:

orderBy in class IndexSegmentSearcher

Parameters:

orderer - the object containing the ordering logic

keyRange - key range specific in read command, used by ANN index

context - to track per sstable cache and per query metrics

Returns:

an iterator of PrimaryKeyWithScore in descending score order

Throws:

IOException

orderResultsBy

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

Description copied from interface: SegmentOrdering

Reorder, limit, and put back into original order the results from a single sstable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Throws:

IOException