Package org.apache.calcite.adapter.mongodb

Class MongoTableScan

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.core.TableScan

org.apache.calcite.adapter.mongodb.MongoTableScan

All Implemented Interfaces:

Cloneable, MongoRel, RelOptNode, Hintable, RelNode

public class MongoTableScan
extends TableScan
implements MongoRel

Relational expression representing a scan of a MongoDB collection.

Additional operations might be applied, using the "find" or "aggregate" methods.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.adapter.mongodb.MongoRel

MongoRel.Implementor

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

RelNode.Context

Field Summary

Fields inherited from class org.apache.calcite.rel.core.TableScan

hints, table

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Fields inherited from interface org.apache.calcite.adapter.mongodb.MongoRel

CONVENTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MongoTableScan(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table, MongoTable mongoTable, RelDataType projectRowType)	Creates a MongoTableScan.

Method Summary

Modifier and Type	Method	Description
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)	Returns the cost of this plan (not including children).
RelNode	copy(RelTraitSet traitSet, List<RelNode> inputs)	Creates a copy of this relational expression, perhaps changing traits and inputs.
RelDataType	deriveRowType()
void	implement(MongoRel.Implementor implementor)
void	register(RelOptPlanner planner)	Registers any special rules specific to this kind of relational expression.

Methods inherited from class org.apache.calcite.rel.core.TableScan

accept, estimateRowCount, explainTerms, getHints, getTable, identity, identity, project

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, childrenAccept, collectVariablesSet, collectVariablesUsed, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTraitSet, getVariablesSet, hashCode, isEnforcer, isValid, metadata, onRegister, recomputeDigest, replaceInput, sole, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.rel.hint.Hintable

attachHints, withHints

Methods inherited from interface org.apache.calcite.rel.RelNode

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, deepEquals, deepHashCode, estimateRowCount, explain, explain, fieldIsNullable, getConvention, getCorrelVariable, getDigest, getExpectedInputRowType, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTable, getVariablesSet, isEnforcer, isValid, metadata, onRegister, recomputeDigest, replaceInput, stripped

Methods inherited from interface org.apache.calcite.plan.RelOptNode

getCluster, getDescription, getId, getTraitSet

Constructor Details

MongoTableScan

protected MongoTableScan(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelOptTable table,
 MongoTable mongoTable,
 RelDataType projectRowType)

Creates a MongoTableScan.

Parameters:

cluster - Cluster

traitSet - Traits

table - Table

mongoTable - MongoDB table

projectRowType - Fields and types to project; null to project raw row

Method Details

copy

public RelNode copy(RelTraitSet traitSet,
 List<RelNode> inputs)

Description copied from interface: RelNode

Creates a copy of this relational expression, perhaps changing traits and inputs.

Sub-classes with other important attributes are encouraged to create variants of this method with more parameters.

Specified by:

copy in interface RelNode

Overrides:

copy in class AbstractRelNode

Parameters:

traitSet - Trait set

inputs - Inputs

Returns:

Copy of this relational expression, substituting traits and inputs

deriveRowType

public RelDataType deriveRowType()

Overrides:

deriveRowType in class TableScan

computeSelfCost

public @Nullable RelOptCost computeSelfCost(RelOptPlanner planner,
 RelMetadataQuery mq)

Description copied from interface: RelNode

Returns the cost of this plan (not including children). The base implementation throws an error; derived classes should override.

NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode), which gives plugins a chance to override the rel's default ideas about cost.

Specified by:

computeSelfCost in interface RelNode

Overrides:

computeSelfCost in class TableScan

Parameters:

planner - Planner for cost calculation

mq - Metadata query

Returns:

Cost of this plan (not including children)

register

public void register(RelOptPlanner planner)

Description copied from interface: RelNode

Registers any special rules specific to this kind of relational expression.

The planner calls this method this first time that it sees a relational expression of this class. The derived class should call RelOptPlanner.addRule(org.apache.calcite.plan.RelOptRule) for each rule, and then call super.register.

Specified by:

register in interface RelNode

Overrides:

register in class AbstractRelNode

Parameters:

planner - Planner to be used to register additional relational expressions

implement

public void implement(MongoRel.Implementor implementor)

Specified by:

implement in interface MongoRel