org.apache.phoenix.compile

Interface QueryPlan

All Superinterfaces:

StatementPlan

All Known Implementing Classes:

AggregatePlan, BaseQueryPlan, ClientAggregatePlan, ClientProcessingPlan, ClientScanPlan, DegenerateQueryPlan, DelegateQueryPlan, EmptyTableQueryPlan, HashJoinPlan, ListJarsQueryPlan, ScanPlan, SortMergeJoinPlan, TraceQueryPlan, TupleProjectionPlan, UnionPlan

public interface QueryPlan
extends StatementPlan

Interface for an executable query plan

Since:

0.1

Method Summary

Methods

Modifier and Type	Method and Description
long	getEstimatedSize()
GroupByCompiler.GroupBy	getGroupBy()
Integer	getLimit()
OrderByCompiler.OrderBy	getOrderBy()
RowProjector	getProjector() Returns projector used to formulate resultSet row
List<List<Scan>>	getScans()
List<KeyRange>	getSplits()
FilterableStatement	getStatement()
TableRef	getTableRef()
boolean	isDegenerate()
boolean	isRowKeyOrdered()
ResultIterator	iterator() Get a result iterator to iterate over the results
ResultIterator	iterator(ParallelScanGrouper scanGrouper)
boolean	useRoundRobinIterator()

Methods inherited from interface org.apache.phoenix.compile.StatementPlan

getContext, getExplainPlan, getParameterMetaData

Method Detail

iterator

ResultIterator iterator()
                        throws SQLException

Get a result iterator to iterate over the results

Returns:

result iterator for iterating over the results

Throws:

SQLException

iterator

ResultIterator iterator(ParallelScanGrouper scanGrouper)
                        throws SQLException

Throws:

SQLException

getEstimatedSize

long getEstimatedSize()

getTableRef

TableRef getTableRef()

getProjector

RowProjector getProjector()

Returns projector used to formulate resultSet row

getLimit

Integer getLimit()

getOrderBy

OrderByCompiler.OrderBy getOrderBy()

getGroupBy

GroupByCompiler.GroupBy getGroupBy()

getSplits

List<KeyRange> getSplits()

getScans

List<List<Scan>> getScans()

getStatement

FilterableStatement getStatement()

isDegenerate

boolean isDegenerate()

isRowKeyOrdered

boolean isRowKeyOrdered()

useRoundRobinIterator

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