org.apache.calcite.adapter.enumerable

Class EnumerableLimit

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.adapter.enumerable.EnumerableLimit

All Implemented Interfaces:

Cloneable, EnumerableRel, RelOptNode, PhysicalNode, RelNode

public class EnumerableLimit
extends SingleRel
implements EnumerableRel

Relational expression that applies a limit and/or offset to its input.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.adapter.enumerable.EnumerableRel

EnumerableRel.Prefer, EnumerableRel.Result

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

RelNode.Context

Field Summary

Fields

Modifier and Type	Field and Description
@Nullable RexNode	fetch
@Nullable RexNode	offset

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

input

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

digest, id, rowType, traitSet

Constructor Summary

Constructors

Constructor and Description
EnumerableLimit(RelOptCluster cluster, RelTraitSet traitSet, RelNode input, @Nullable RexNode offset, @Nullable RexNode fetch) Creates an EnumerableLimit.

Method Summary

Modifier and Type	Method and Description
EnumerableLimit	copy(RelTraitSet traitSet, List<RelNode> newInputs) Creates a copy of this relational expression, perhaps changing traits and inputs.
static EnumerableLimit	create(RelNode input, @Nullable RexNode offset, @Nullable RexNode fetch) Creates an EnumerableLimit.
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
EnumerableRel.Result	implement(EnumerableRelImplementor implementor, EnumerableRel.Prefer pref) Creates a plan for this expression according to a calling convention.

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

childrenAccept, deriveRowType, estimateRowCount, getInput, getInputs, replaceInput

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.adapter.enumerable.EnumerableRel

deriveTraits, getDeriveMode, passThroughTraits

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

derive, derive, passThrough

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

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

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

getCluster, getDescription, getId, getTraitSet

Field Detail

offset

public final @Nullable RexNode offset

fetch

public final @Nullable RexNode fetch

Constructor Detail

EnumerableLimit

public EnumerableLimit(RelOptCluster cluster,
                       RelTraitSet traitSet,
                       RelNode input,
                       @Nullable RexNode offset,
                       @Nullable RexNode fetch)

Creates an EnumerableLimit.

Use create(org.apache.calcite.rel.RelNode, org.apache.calcite.rex.RexNode, org.apache.calcite.rex.RexNode) unless you know what you're doing.

Method Detail

create

public static EnumerableLimit create(RelNode input,
                                     @Nullable RexNode offset,
                                     @Nullable RexNode fetch)

Creates an EnumerableLimit.

copy

public EnumerableLimit copy(RelTraitSet traitSet,
                            List<RelNode> newInputs)

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

newInputs - Inputs

Returns:

Copy of this relational expression, substituting traits and inputs

explainTerms

public RelWriter explainTerms(RelWriter pw)

Description copied from class: AbstractRelNode

Describes the inputs and attributes of this relational expression. Each node should call super.explainTerms, then call the RelWriter.input(String, RelNode) and RelWriter.item(String, Object) methods for each input and attribute.

Overrides:

explainTerms in class SingleRel

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

implement

public EnumerableRel.Result implement(EnumerableRelImplementor implementor,
                                      EnumerableRel.Prefer pref)

Description copied from interface: EnumerableRel

Creates a plan for this expression according to a calling convention.

Specified by:

implement in interface EnumerableRel

Parameters:

implementor - Implementor

pref - Preferred representation for rows in result expression

Returns:

Plan for this expression according to a calling convention