org.apache.cassandra.db

Interface PartitionRangeReadQuery

All Superinterfaces:

ReadQuery

All Known Implementing Classes:

PartitionRangeReadCommand, VirtualTablePartitionRangeReadQuery

public interface PartitionRangeReadQuery
extends ReadQuery

A ReadQuery for a range of partitions.

Method Summary

Modifier and Type	Method and Description
static ReadQuery	create(TableMetadata table, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DataRange dataRange)
DataRange	dataRange()
default QueryPager	getPager(PagingState pagingState, ProtocolVersion protocolVersion) Returns a pager for the query.
default boolean	selectsClustering(DecoratedKey key, Clustering<?> clustering)
default boolean	selectsFullPartition() Checks if this ReadQuery selects full partitions, that is it has no filtering on clustering or regular columns.
default boolean	selectsKey(DecoratedKey key)
PartitionRangeReadQuery	withUpdatedLimit(DataLimits newLimits) Creates a new PartitionRangeReadQuery with the updated limits.
PartitionRangeReadQuery	withUpdatedLimitsAndDataRange(DataLimits newLimits, DataRange newDataRange) Creates a new PartitionRangeReadQuery with the updated limits and data range.

Methods inherited from interface org.apache.cassandra.db.ReadQuery

columnFilter, empty, execute, executeInternal, executeLocally, executionController, isEmpty, limits, maybeValidateIndex, metadata, nowInSec, rowFilter

Method Detail

create

static ReadQuery create(TableMetadata table,
                        int nowInSec,
                        ColumnFilter columnFilter,
                        RowFilter rowFilter,
                        DataLimits limits,
                        DataRange dataRange)

dataRange

DataRange dataRange()

withUpdatedLimit

PartitionRangeReadQuery withUpdatedLimit(DataLimits newLimits)

Creates a new PartitionRangeReadQuery with the updated limits.

Parameters:

newLimits - the new limits

Returns:

the new PartitionRangeReadQuery

withUpdatedLimitsAndDataRange

PartitionRangeReadQuery withUpdatedLimitsAndDataRange(DataLimits newLimits,
                                                      DataRange newDataRange)

Creates a new PartitionRangeReadQuery with the updated limits and data range.

Parameters:

newLimits - the new limits

Returns:

the new PartitionRangeReadQuery

getPager

default QueryPager getPager(PagingState pagingState,
                            ProtocolVersion protocolVersion)

Description copied from interface: ReadQuery

Returns a pager for the query.

Specified by:

getPager in interface ReadQuery

Parameters:

pagingState - the PagingState to start from if this is a paging continuation. This can be null if this is the start of paging.

protocolVersion - the protocol version to use for the paging state of that pager.

Returns:

a pager for the query.

selectsKey

default boolean selectsKey(DecoratedKey key)

Specified by:

selectsKey in interface ReadQuery

Returns:

true if the read query would select the given key, including checks against the row filter, if checkRowFilter is true

selectsClustering

default boolean selectsClustering(DecoratedKey key,
                                  Clustering<?> clustering)

Specified by:

selectsClustering in interface ReadQuery

Returns:

true if the read query would select the given clustering, including checks against the row filter, if checkRowFilter is true

selectsFullPartition

default boolean selectsFullPartition()

Description copied from interface: ReadQuery

Checks if this ReadQuery selects full partitions, that is it has no filtering on clustering or regular columns.

Specified by:

selectsFullPartition in interface ReadQuery

Returns:

true if this ReadQuery selects full partitions, false otherwise.