Package org.apache.cassandra.db.virtual

Interface VirtualTable

All Known Implementing Classes:

AbstractMutableVirtualTable, AbstractVirtualTable, AbstractVirtualTable.SimpleTable, BatchMetricsTable, CIDRFilteringMetricsTable.CIDRFilteringMetricsCountsTable, CIDRFilteringMetricsTable.CIDRFilteringMetricsLatenciesTable, ColumnIndexesSystemView, InternodeInboundTable, InternodeOutboundTable, LogMessagesTable, SegmentsSystemView, SnapshotsTable, SSTableIndexesSystemView, StreamingVirtualTable

public interface VirtualTable

A system view used to expose system information.

Method Summary

Modifier and Type	Method	Description
default boolean	allowFilteringImplicitly()	Tells whether ALLOW FILTERING is implicitly added to select statement which requires it.
void	apply(PartitionUpdate update)	Applies the specified update, if supported.
TableMetadata	metadata()	Returns the view metadata.
default java.lang.String	name()	Returns the view name.
UnfilteredPartitionIterator	select(DataRange dataRange, ColumnFilter columnFilter)	Selects the rows from a range of partitions.
UnfilteredPartitionIterator	select(DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter, ColumnFilter columnFilter)	Selects the rows from a single partition.
void	truncate()	Truncates data from the underlying source, if supported.

Method Detail

name

default java.lang.String name()

Returns the view name.

Returns:

the view name.

metadata

TableMetadata metadata()

Returns the view metadata.

Returns:

the view metadata.

apply

void apply(PartitionUpdate update)

Applies the specified update, if supported.

Parameters:

update - the update to apply

select

UnfilteredPartitionIterator select(DecoratedKey partitionKey,
                                   ClusteringIndexFilter clusteringIndexFilter,
                                   ColumnFilter columnFilter)

Selects the rows from a single partition.

Parameters:

partitionKey - the partition key

clusteringIndexFilter - the clustering columns to selected

columnFilter - the selected columns

Returns:

the rows corresponding to the requested data.

select

UnfilteredPartitionIterator select(DataRange dataRange,
                                   ColumnFilter columnFilter)

Selects the rows from a range of partitions.

Parameters:

dataRange - the range of data to retrieve

columnFilter - the selected columns

Returns:

the rows corresponding to the requested data.

truncate

void truncate()

Truncates data from the underlying source, if supported.

allowFilteringImplicitly

default boolean allowFilteringImplicitly()

Tells whether ALLOW FILTERING is implicitly added to select statement which requires it. Defaults to true.

Returns:

true if ALLOW FILTERING is implicitly added to select statements when required, false otherwise.