Impala
Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
com.cloudera.impala.planner.ScanNode Class Referenceabstract
Inheritance diagram for com.cloudera.impala.planner.ScanNode:
Collaboration diagram for com.cloudera.impala.planner.ScanNode:

Public Member Functions

 ScanNode (PlanNodeId id, TupleDescriptor desc, String displayName)
 
TupleDescriptor getTupleDesc ()
 
List< TScanRangeLocations > getScanRangeLocations ()
 
boolean isTableMissingStats ()
 
boolean isTableMissingTableStats ()
 
boolean isTableMissingColumnStats ()
 
long getInputCardinality ()
 
PlanNodeId getId ()
 
void setId (PlanNodeId id)
 
long getLimit ()
 
boolean hasLimit ()
 
long getPerHostMemCost ()
 
long getCardinality ()
 
int getNumNodes ()
 
float getAvgRowSize ()
 
void setFragment (PlanFragment fragment)
 
PlanFragment getFragment ()
 
List< ExprgetConjuncts ()
 
ExprSubstitutionMap getOutputSmap ()
 
void setOutputSmap (ExprSubstitutionMap smap)
 
Set< ExprIdgetAssignedConjuncts ()
 
void setAssignedConjuncts (Set< ExprId > conjuncts)
 
void setLimit (long limit)
 
void unsetLimit ()
 
ArrayList< TupleIdgetTupleIds ()
 
ArrayList< TupleIdgetTblRefIds ()
 
void setTblRefIds (ArrayList< TupleId > ids)
 
Set< TupleIdgetNullableTupleIds ()
 
void addConjuncts (List< Expr > conjuncts)
 
void transferConjuncts (PlanNode recipient)
 
String getExplainString ()
 
TPlan treeToThrift ()
 
void init (Analyzer analyzer) throws InternalException
 
boolean isBlockingNode ()
 
void computeCosts (TQueryOptions queryOptions)
 

Static Public Member Functions

static long addCardinalities (long a, long b)
 
static long multiplyCardinalities (long a, long b)
 

Protected Member Functions

String debugString ()
 
String getStatsExplainString (String prefix, TExplainLevel detailLevel)
 
final String getExplainString (String rootPrefix, String prefix, TExplainLevel detailLevel)
 
String getExplainString (List<?extends Expr > exprs)
 
void setDisplayName (String s)
 
final String getDisplayLabel ()
 
String getDisplayLabelDetail ()
 
String getNodeExplainString (String rootPrefix, String detailPrefix, TExplainLevel detailLevel)
 
String getOffsetExplainString (String prefix)
 
void assignConjuncts (Analyzer analyzer)
 
ExprSubstitutionMap getCombinedChildSmap ()
 
void createDefaultSmap (Analyzer analyzer)
 
void computeStats (Analyzer analyzer)
 
long capAtLimit (long cardinality)
 
void markSlotsMaterialized (Analyzer analyzer, List< Expr > exprs)
 
void computeMemLayout (Analyzer analyzer)
 
double computeSelectivity ()
 
abstract void toThrift (TPlanNode msg)
 
boolean hasValidStats ()
 

Static Protected Member Functions

static TNetworkAddress addressToTNetworkAddress (String address)
 

Protected Attributes

final TupleDescriptor desc_
 
long inputCardinality_ = -1
 
int numPartitionsMissingStats_ = 0
 
List< TScanRangeLocations > scanRanges_
 
String displayName_
 
PlanNodeId id_
 
long limit_
 
ArrayList< TupleIdtupleIds_
 
ArrayList< TupleIdtblRefIds_
 
Set< TupleIdnullableTupleIds_ = Sets.newHashSet()
 
List< Exprconjuncts_ = Lists.newArrayList()
 
PlanFragment fragment_
 
ExprSubstitutionMap outputSmap_
 
Set< ExprIdassignedConjuncts_
 
long cardinality_
 
int numNodes_
 
float avgRowSize_
 
long perHostMemCost_ = -1
 

Static Protected Attributes

static final int DEFAULT_BATCH_SIZE = 1024
 

Detailed Description

Representation of the common elements of all scan nodes.

Definition at line 32 of file ScanNode.java.

Constructor & Destructor Documentation

com.cloudera.impala.planner.ScanNode.ScanNode ( PlanNodeId  id,
TupleDescriptor  desc,
String  displayName 
)
inline

Member Function Documentation

static long com.cloudera.impala.planner.PlanNode.addCardinalities ( long  a,
long  b 
)
inlinestaticinherited
void com.cloudera.impala.planner.PlanNode.addConjuncts ( List< Expr conjuncts)
inlineinherited

Definition at line 209 of file PlanNode.java.

static TNetworkAddress com.cloudera.impala.planner.ScanNode.addressToTNetworkAddress ( String  address)
inlinestaticprotected

Helper function to parse a "host:port" address string into TNetworkAddress This is called with ipaddress:port when doing scan range assignment.

Definition at line 132 of file ScanNode.java.

Referenced by com.cloudera.impala.planner.HBaseScanNode.computeScanRangeLocations(), and com.cloudera.impala.planner.DataSourceScanNode.computeScanRangeLocations().

void com.cloudera.impala.planner.PlanNode.computeCosts ( TQueryOptions  queryOptions)
inlineinherited

Estimates the cost of executing this PlanNode. Currently only sets perHostMemCost_. May only be called after this PlanNode has been placed in a PlanFragment because the cost computation is dependent on the enclosing fragment's data partition.

Definition at line 562 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.perHostMemCost_.

void com.cloudera.impala.planner.PlanNode.computeStats ( Analyzer  analyzer)
inlineprotectedinherited

Computes planner statistics: avgRowSize_, numNodes_, cardinality_. Subclasses need to override this. Assumes that it has already been called on all children. and that DescriptorTable.computePhysMemLayout() has been called. This is broken out of init() so that it can be called separately from init() (to facilitate inserting additional nodes during plan partitioning w/o the need to call init() recursively on the whole tree again).

Definition at line 441 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.avgRowSize_, com.cloudera.impala.planner.PlanNode.numNodes_, and com.cloudera.impala.planner.PlanNode.tupleIds_.

Referenced by com.cloudera.impala.planner.PlanNode.init().

void com.cloudera.impala.planner.PlanNode.createDefaultSmap ( Analyzer  analyzer)
inlineprotectedinherited
String com.cloudera.impala.planner.ScanNode.debugString ( )
inlineprotected
Set<ExprId> com.cloudera.impala.planner.PlanNode.getAssignedConjuncts ( )
inlineinherited
ExprSubstitutionMap com.cloudera.impala.planner.PlanNode.getCombinedChildSmap ( )
inlineprotectedinherited
List<Expr> com.cloudera.impala.planner.PlanNode.getConjuncts ( )
inlineinherited
String com.cloudera.impala.planner.PlanNode.getDisplayLabelDetail ( )
inlineprotectedinherited

Subclasses can override to provide a node specific detail string that is displayed to the user. e.g. scan can return the table name.

Definition at line 234 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.PlanNode.treeToThriftHelper().

final String com.cloudera.impala.planner.PlanNode.getExplainString ( String  rootPrefix,
String  prefix,
TExplainLevel  detailLevel 
)
inlineprotectedinherited
String com.cloudera.impala.planner.PlanNode.getExplainString ( List<?extends Expr exprs)
inlineprotectedinherited

Definition at line 506 of file PlanNode.java.

PlanFragment com.cloudera.impala.planner.PlanNode.getFragment ( )
inlineinherited
long com.cloudera.impala.planner.PlanNode.getLimit ( )
inlineinherited
String com.cloudera.impala.planner.PlanNode.getNodeExplainString ( String  rootPrefix,
String  detailPrefix,
TExplainLevel  detailLevel 
)
inlineprotectedinherited

Return the node-specific details. Subclass should override this function. Each line should be prefix by detailPrefix.

Definition at line 325 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.PlanNode.getExplainString().

Set<TupleId> com.cloudera.impala.planner.PlanNode.getNullableTupleIds ( )
inlineinherited
String com.cloudera.impala.planner.PlanNode.getOffsetExplainString ( String  prefix)
inlineprotectedinherited

Return the offset_ details, if applicable. This is available separately from 'getNodeExplainString' because we want to output 'limit: ...' (which can be printed from PlanNode) before 'offset: ...', which is only printed from SortNodes right now.

Definition at line 336 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.PlanNode.getExplainString().

ExprSubstitutionMap com.cloudera.impala.planner.PlanNode.getOutputSmap ( )
inlineinherited

Definition at line 178 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.outputSmap_.

long com.cloudera.impala.planner.PlanNode.getPerHostMemCost ( )
inlineinherited
List<TScanRangeLocations> com.cloudera.impala.planner.ScanNode.getScanRangeLocations ( )
inline

Returns all scan ranges plus their locations.

Definition at line 54 of file ScanNode.java.

References com.cloudera.impala.planner.ScanNode.scanRanges_.

String com.cloudera.impala.planner.ScanNode.getStatsExplainString ( String  prefix,
TExplainLevel  detailLevel 
)
inlineprotected

Returns the explain string for table and columns stats to be included into the a ScanNode's explain string. The given prefix is prepended to each of the lines. The prefix is used for proper formatting when the string returned by this method is embedded in a query's explain plan.

Definition at line 75 of file ScanNode.java.

References com.cloudera.impala.planner.ScanNode.desc_, com.cloudera.impala.analysis.TupleDescriptor.getSlots(), com.cloudera.impala.analysis.TupleDescriptor.getTable(), and com.cloudera.impala.planner.ScanNode.numPartitionsMissingStats_.

Referenced by com.cloudera.impala.planner.DataSourceScanNode.getNodeExplainString(), com.cloudera.impala.planner.HBaseScanNode.getNodeExplainString(), and com.cloudera.impala.planner.HdfsScanNode.getNodeExplainString().

ArrayList<TupleId> com.cloudera.impala.planner.PlanNode.getTblRefIds ( )
inlineinherited
TupleDescriptor com.cloudera.impala.planner.ScanNode.getTupleDesc ( )
inline

Definition at line 49 of file ScanNode.java.

References com.cloudera.impala.planner.ScanNode.desc_.

boolean com.cloudera.impala.planner.PlanNode.hasValidStats ( )
inlineprotectedinherited
void com.cloudera.impala.planner.PlanNode.init ( Analyzer  analyzer) throws InternalException
inlineinherited

Computes the full internal state, including smap and planner-relevant statistics (calls computeStats()), marks all slots referenced by this node as materialized and computes the mem layout of all materialized tuples (with the assumption that slots that are needed by ancestor PlanNodes have already been marked). Also performs final expr substitution with childrens' smaps and computes internal state required for toThrift(). This is called directly after construction.

Definition at line 392 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.assignConjuncts(), com.cloudera.impala.planner.PlanNode.computeStats(), and com.cloudera.impala.planner.PlanNode.createDefaultSmap().

boolean com.cloudera.impala.planner.PlanNode.isBlockingNode ( )
inlineinherited

Returns true if this plan node can output its first row only after consuming all rows of all its children. This method is used to group plan nodes into pipelined units for resource estimation.

Definition at line 555 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.PipelinedPlanNodeSet.computePlanNodeSets().

boolean com.cloudera.impala.planner.ScanNode.isTableMissingColumnStats ( )
inline
boolean com.cloudera.impala.planner.ScanNode.isTableMissingStats ( )
inline

Returns true if the table underlying this scan is missing table stats or column stats relevant to this scan node.

Definition at line 111 of file ScanNode.java.

References com.cloudera.impala.planner.ScanNode.isTableMissingColumnStats(), and com.cloudera.impala.planner.ScanNode.isTableMissingTableStats().

void com.cloudera.impala.planner.PlanNode.markSlotsMaterialized ( Analyzer  analyzer,
List< Expr exprs 
)
inlineprotectedinherited

Marks all slots referenced in exprs as materialized.

Definition at line 464 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.HdfsScanNode.init().

static long com.cloudera.impala.planner.PlanNode.multiplyCardinalities ( long  a,
long  b 
)
inlinestaticinherited

Computes and returns the product of two cardinalities. If an overflow occurs, the maximum Long value is returned (Long.MAX_VALUE).

Definition at line 541 of file PlanNode.java.

Referenced by com.cloudera.impala.planner.CrossJoinNode.computeStats(), and com.cloudera.impala.planner.HashJoinNode.getJoinCardinality().

void com.cloudera.impala.planner.PlanNode.setAssignedConjuncts ( Set< ExprId conjuncts)
inlineinherited
void com.cloudera.impala.planner.PlanNode.setDisplayName ( String  s)
inlineprotectedinherited

Definition at line 223 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.displayName_.

void com.cloudera.impala.planner.PlanNode.setFragment ( PlanFragment  fragment)
inlineinherited

Definition at line 175 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.fragment_.

void com.cloudera.impala.planner.PlanNode.setId ( PlanNodeId  id)
inlineinherited

Definition at line 165 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.id_.

void com.cloudera.impala.planner.PlanNode.setLimit ( long  limit)
inlineinherited

Set the limit_ to the given limit_ only if the limit_ hasn't been set, or the new limit_ is lower.

Parameters
limit_

Definition at line 190 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.limit_.

void com.cloudera.impala.planner.PlanNode.setOutputSmap ( ExprSubstitutionMap  smap)
inlineinherited

Definition at line 179 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.outputSmap_.

void com.cloudera.impala.planner.PlanNode.setTblRefIds ( ArrayList< TupleId ids)
inlineinherited

Definition at line 202 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.tblRefIds_.

abstract void com.cloudera.impala.planner.PlanNode.toThrift ( TPlanNode  msg)
abstractprotectedinherited
void com.cloudera.impala.planner.PlanNode.transferConjuncts ( PlanNode  recipient)
inlineinherited

Definition at line 214 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.conjuncts_.

TPlan com.cloudera.impala.planner.PlanNode.treeToThrift ( )
inlineinherited
void com.cloudera.impala.planner.PlanNode.unsetLimit ( )
inlineinherited

Definition at line 194 of file PlanNode.java.

References com.cloudera.impala.planner.PlanNode.limit_.

Member Data Documentation

final int com.cloudera.impala.planner.PlanNode.DEFAULT_BATCH_SIZE = 1024
staticprotectedinherited

Definition at line 63 of file PlanNode.java.

PlanNodeId com.cloudera.impala.planner.PlanNode.id_
protectedinherited
Set<TupleId> com.cloudera.impala.planner.PlanNode.nullableTupleIds_ = Sets.newHashSet()
protectedinherited
int com.cloudera.impala.planner.ScanNode.numPartitionsMissingStats_ = 0
protected
ArrayList<TupleId> com.cloudera.impala.planner.PlanNode.tblRefIds_
protectedinherited

The documentation for this class was generated from the following file: