Package org.apache.cassandra.index.sai.plan

Class QueryController

java.lang.Object

org.apache.cassandra.index.sai.plan.QueryController

public class QueryController
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_MATERIALIZED_KEYS	The maximum number of primary keys we will materialize when performing hybrid vector search.

Constructor Summary

Constructors

Constructor	Description
QueryController(ColumnFamilyStore cfs, ReadCommand command, RowFilter indexFilter, QueryContext queryContext)

Method Summary

Modifier and Type	Method	Description
List<DataRange>	dataRanges()
boolean	doesNotSelect(PrimaryKey key)	Returns whether this query is not selecting the PrimaryKey.
PrimaryKey	firstPrimaryKeyInRange()
KeyRangeIterator.Builder	getIndexQueryResults(Collection<Expression> expressions)	Build a KeyRangeIterator.Builder from the given list of Expressions.
CloseableIterator<PrimaryKeyWithScore>	getTopKRows(KeyRangeIterator source, QueryViewBuilder.QueryExpressionView queryExpressionView)
CloseableIterator<PrimaryKeyWithScore>	getTopKRows(QueryViewBuilder.QueryExpressionView queryExpressionView)
boolean	hasAnalyzer(RowFilter.Expression expression)
RowFilter	indexFilter()
StorageAttachedIndex	indexFor(RowFilter.Expression expression)
PrimaryKey	lastPrimaryKeyInRange()
AbstractBounds<PartitionPosition>	mergeRange()
TableMetadata	metadata()
PrimaryKey.Factory	primaryKeyFactory()
UnfilteredRowIterator	queryStorage(List<PrimaryKey> keys, ReadExecutionController executionController)
UnfilteredRowIterator	queryStorage(PrimaryKey key, ColumnFamilyStore.ViewFragment view, ReadExecutionController executionController)	Get an iterator over the row(s) for this primary key.
boolean	usesStrictFiltering()

Methods inherited from class java.lang.Object

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

Field Details

MAX_MATERIALIZED_KEYS

public static int MAX_MATERIALIZED_KEYS

The maximum number of primary keys we will materialize when performing hybrid vector search. If this limit is exceeded, we switch to an order-by-then-filter execution path

Constructor Details

QueryController

public QueryController(ColumnFamilyStore cfs,
 ReadCommand command,
 RowFilter indexFilter,
 QueryContext queryContext)

Method Details

primaryKeyFactory

public PrimaryKey.Factory primaryKeyFactory()

firstPrimaryKeyInRange

public PrimaryKey firstPrimaryKeyInRange()

lastPrimaryKeyInRange

public PrimaryKey lastPrimaryKeyInRange()

metadata

public TableMetadata metadata()

indexFilter

public RowFilter indexFilter()

usesStrictFiltering

public boolean usesStrictFiltering()

dataRanges

public List<DataRange> dataRanges()

Returns:

token ranges used in the read command

mergeRange

public AbstractBounds<PartitionPosition> mergeRange()

indexFor

@Nullable
public StorageAttachedIndex indexFor(RowFilter.Expression expression)

hasAnalyzer

public boolean hasAnalyzer(RowFilter.Expression expression)

queryStorage

public UnfilteredRowIterator queryStorage(List<PrimaryKey> keys,
 ReadExecutionController executionController)

queryStorage

public UnfilteredRowIterator queryStorage(PrimaryKey key,
 ColumnFamilyStore.ViewFragment view,
 ReadExecutionController executionController)

Get an iterator over the row(s) for this primary key. Restrict the search to the specified view. Apply the SOURCE_TABLE_ROW_TRANSFORMER so that resulting cells have the source memtable/sstable. Expect one row for a fully qualified primary key or all rows within a partition for a static primary key.

Parameters:

key - primary key to fetch from storage.

executionController - the executionController to use when querying storage

Returns:

an iterator of rows matching the query

getIndexQueryResults

public KeyRangeIterator.Builder getIndexQueryResults(Collection<Expression> expressions)

Build a KeyRangeIterator.Builder from the given list of Expressions.

This is achieved by creating an on-disk view of the query that maps the expressions to the SSTableIndexs that will satisfy the expression.

Each QueryViewBuilder.QueryExpressionView is then passed to IndexSearchResultIterator.build(QueryViewBuilder.QueryExpressionView, AbstractBounds, QueryContext, boolean, Runnable) to search the in-memory indexes associated with the expression and the SSTable indexes, the results of which are unioned and returned.

The results from each call to IndexSearchResultIterator.build(QueryViewBuilder.QueryExpressionView, AbstractBounds, QueryContext, boolean, Runnable) are added to a KeyRangeIntersectionIterator and returned if strict filtering is allowed.

If strict filtering is not allowed, indexes are split into two groups according to the repaired status of their backing SSTables. Results from searches over the repaired group are added to a KeyRangeIntersectionIterator, which is then added, along with results from searches on the unrepaired set, to a top-level KeyRangeUnionIterator, and returned. This is done to ensure that AND queries do not prematurely filter out matches on un-repaired partial updates. Post-filtering must also take this into account. (see FilterTree.isSatisfiedBy(DecoratedKey, Row, Row)) Note that Memtable-attached indexes are treated as part of the unrepaired set.

doesNotSelect

public boolean doesNotSelect(PrimaryKey key)

Returns whether this query is not selecting the PrimaryKey. The query does not select the key if both of the following statements are false: 1. The table associated with the query is not using clustering keys 2. The clustering index filter for the command wants the row.

Item 2 is important in paged queries where the ClusteringIndexSliceFilter for subsequent paged queries may not select rows that are returned by the index search because that is initially partition based.

Parameters:

key - The PrimaryKey to be tested

Returns:

true if the key is not selected by the query

getTopKRows

public CloseableIterator<PrimaryKeyWithScore> getTopKRows(QueryViewBuilder.QueryExpressionView queryExpressionView)

getTopKRows

public CloseableIterator<PrimaryKeyWithScore> getTopKRows(KeyRangeIterator source,
 QueryViewBuilder.QueryExpressionView queryExpressionView)