org.apache.phoenix.execute

Class ScanPlan

java.lang.Object

org.apache.phoenix.execute.BaseQueryPlan

org.apache.phoenix.execute.ScanPlan

All Implemented Interfaces:

QueryPlan, StatementPlan

public class ScanPlan
extends BaseQueryPlan

Query plan for a basic table scan

Since:

0.1

Field Summary

Fields inherited from class org.apache.phoenix.execute.BaseQueryPlan

context, DEFAULT_ESTIMATED_SIZE, dynamicFilter, estimatedRows, estimatedSize, estimateInfoTimestamp, groupBy, limit, offset, orderBy, parallelIteratorFactory, paramMetaData, projection, statement, tableRef, tableRefs

Constructor Summary

Constructors

Constructor and Description
ScanPlan(StatementContext context, FilterableStatement statement, TableRef table, RowProjector projector, Integer limit, Integer offset, OrderByCompiler.OrderBy orderBy, ParallelIteratorFactory parallelIteratorFactory, boolean allowPageFilter)

Method Summary

Methods

Modifier and Type	Method and Description
Long	getEstimatedBytesToScan()
Long	getEstimatedRowsToScan()
Long	getEstimateInfoTimestamp()
List<List<Scan>>	getScans()
List<KeyRange>	getSplits()
protected ResultIterator	newIterator(ParallelScanGrouper scanGrouper, Scan scan, Map<ImmutableBytesPtr,ServerCacheClient.ServerCache> caches)
boolean	useRoundRobinIterator()

Methods inherited from class org.apache.phoenix.execute.BaseQueryPlan

getContext, getDynamicFilter, getEstimatedSize, getExplainPlan, getGroupBy, getLimit, getOffset, getOperation, getOrderBy, getParameterMetaData, getProjector, getSourceRefs, getStatement, getTableRef, isDegenerate, isRowKeyOrdered, iterator, iterator, iterator, iterator

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanPlan

public ScanPlan(StatementContext context,
        FilterableStatement statement,
        TableRef table,
        RowProjector projector,
        Integer limit,
        Integer offset,
        OrderByCompiler.OrderBy orderBy,
        ParallelIteratorFactory parallelIteratorFactory,
        boolean allowPageFilter)
         throws SQLException

Throws:

SQLException

Method Detail

getSplits

public List<KeyRange> getSplits()

getScans

public List<List<Scan>> getScans()

newIterator

protected ResultIterator newIterator(ParallelScanGrouper scanGrouper,
                         Scan scan,
                         Map<ImmutableBytesPtr,ServerCacheClient.ServerCache> caches)
                              throws SQLException

Specified by:

newIterator in class BaseQueryPlan

Throws:

SQLException

useRoundRobinIterator

public boolean useRoundRobinIterator()
                              throws SQLException

Returns:

whether underlying ResultScanner can be picked up in a round-robin fashion. Generally, selecting scanners in such a fashion is possible if rows don't have to be returned back in a certain order.

Throws:

SQLException

getEstimatedRowsToScan

public Long getEstimatedRowsToScan()
                            throws SQLException

Specified by:

getEstimatedRowsToScan in interface StatementPlan

Overrides:

getEstimatedRowsToScan in class BaseQueryPlan

Returns:

estimated number of rows that will be scanned when this statement plan is been executed. Returns null if the estimate cannot be provided.

Throws:

SQLException

getEstimatedBytesToScan

public Long getEstimatedBytesToScan()
                             throws SQLException

Specified by:

getEstimatedBytesToScan in interface StatementPlan

Overrides:

getEstimatedBytesToScan in class BaseQueryPlan

Returns:

estimated number of bytes that will be scanned when this statement plan is been executed. Returns null if the estimate cannot be provided.

Throws:

SQLException

getEstimateInfoTimestamp

public Long getEstimateInfoTimestamp()
                              throws SQLException

Specified by:

getEstimateInfoTimestamp in interface StatementPlan

Overrides:

getEstimateInfoTimestamp in class BaseQueryPlan

Returns:

timestamp at which the estimate information (estimated bytes and estimated rows) was computed. executed. Returns null if the information cannot be provided.

Throws:

SQLException