org.apache.calcite.rel.core

Class TableFunctionScan

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.core.TableFunctionScan

All Implemented Interfaces:

Cloneable, RelOptNode, RelNode

Direct Known Subclasses:

EnumerableTableFunctionScan, LogicalTableFunctionScan

public abstract class TableFunctionScan
extends AbstractRelNode

Relational expression that calls a table-valued function.

The function returns a result set. It can appear as a leaf in a query tree, or can be applied to relational inputs.

See Also:

LogicalTableFunctionScan

Nested Class Summary

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

RelNode.Context

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable com.google.common.collect.ImmutableSet<RelColumnMapping>	columnMappings

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

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TableFunctionScan(RelInput input) Creates a TableFunctionScan by parsing serialized output.
protected	TableFunctionScan(RelOptCluster cluster, RelTraitSet traitSet, List<RelNode> inputs, RexNode rexCall, @Nullable Type elementType, RelDataType rowType, @Nullable Set<RelColumnMapping> columnMappings) Creates a TableFunctionScan.

Method Summary

Modifier and Type	Method and Description
RelNode	accept(RexShuttle shuttle) Accepts a visit from a shuttle.
TableFunctionScan	copy(RelTraitSet traitSet, List<RelNode> inputs) Creates a copy of this relational expression, perhaps changing traits and inputs.
abstract TableFunctionScan	copy(RelTraitSet traitSet, List<RelNode> inputs, RexNode rexCall, @Nullable Type elementType, RelDataType rowType, @Nullable Set<RelColumnMapping> columnMappings) Copies this relational expression, substituting traits and inputs.
double	estimateRowCount(RelMetadataQuery mq) Returns an estimate of the number of rows this relational expression will return.
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
RexNode	getCall() Returns function invocation expression.
@Nullable Set<RelColumnMapping>	getColumnMappings() Returns set of mappings known for this table function, or null if unknown (not the same as empty!).
@Nullable Type	getElementType() Returns element type of the collection that will implement this table.
List<RelNode>	getInputs() Returns an array of this relational expression's inputs.
void	replaceInput(int ordinalInParent, RelNode p) Replaces the ordinalInParentth input.

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

accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeSelfCost, deepEquals, deepHashCode, deriveRowType, 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.rel.RelNode

explain, fieldIsNullable

Field Detail

columnMappings

protected final @Nullable com.google.common.collect.ImmutableSet<RelColumnMapping> columnMappings

Constructor Detail

TableFunctionScan

protected TableFunctionScan(RelOptCluster cluster,
                            RelTraitSet traitSet,
                            List<RelNode> inputs,
                            RexNode rexCall,
                            @Nullable Type elementType,
                            RelDataType rowType,
                            @Nullable Set<RelColumnMapping> columnMappings)

Creates a TableFunctionScan.

Parameters:

cluster - Cluster that this relational expression belongs to

inputs - 0 or more relational inputs

traitSet - Trait set

rexCall - Function invocation expression

elementType - Element type of the collection that will implement this table

rowType - Row type produced by function

columnMappings - Column mappings associated with this function

TableFunctionScan

protected TableFunctionScan(RelInput input)

Creates a TableFunctionScan by parsing serialized output.

Method Detail

copy

public final TableFunctionScan 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

copy

public abstract TableFunctionScan copy(RelTraitSet traitSet,
                                       List<RelNode> inputs,
                                       RexNode rexCall,
                                       @Nullable Type elementType,
                                       RelDataType rowType,
                                       @Nullable Set<RelColumnMapping> columnMappings)

Copies this relational expression, substituting traits and inputs.

Parameters:

traitSet - Traits

inputs - 0 or more relational inputs

rexCall - Function invocation expression

elementType - Element type of the collection that will implement this table

rowType - Row type produced by function

columnMappings - Column mappings associated with this function

Returns:

Copy of this relational expression, substituting traits and inputs

getInputs

public List<RelNode> getInputs()

Description copied from interface: RelNode

Returns an array of this relational expression's inputs. If there are no inputs, returns an empty list, not null.

Specified by:

getInputs in interface RelOptNode

Specified by:

getInputs in interface RelNode

Overrides:

getInputs in class AbstractRelNode

Returns:

Array of this relational expression's inputs

accept

public RelNode accept(RexShuttle shuttle)

Description copied from interface: RelNode

Accepts a visit from a shuttle. If the shuttle updates expression, then a copy of the relation should be created. This new relation might have a different row-type.

Specified by:

accept in interface RelNode

Overrides:

accept in class AbstractRelNode

Parameters:

shuttle - Shuttle

Returns:

A copy of this node incorporating changes made by the shuttle to this node's children

replaceInput

public void replaceInput(int ordinalInParent,
                         RelNode p)

Description copied from interface: RelNode

Replaces the ordinalInParent^th input. You must override this method if you override RelNode.getInputs().

Specified by:

replaceInput in interface RelNode

Overrides:

replaceInput in class AbstractRelNode

Parameters:

ordinalInParent - Position of the child input, 0 is the first

p - New node that should be put at position ordinalInParent

estimateRowCount

public double estimateRowCount(RelMetadataQuery mq)

Description copied from interface: RelNode

Returns an estimate of the number of rows this relational expression will return.

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

Specified by:

estimateRowCount in interface RelNode

Overrides:

estimateRowCount in class AbstractRelNode

Parameters:

mq - Metadata query

Returns:

Estimate of the number of rows this relational expression will return

getCall

public RexNode getCall()

Returns function invocation expression.

Within this rexCall, instances of RexInputRef refer to entire input RelNodes rather than their fields.

Returns:

function invocation expression

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 AbstractRelNode

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

getColumnMappings

public @Nullable Set<RelColumnMapping> getColumnMappings()

Returns set of mappings known for this table function, or null if unknown (not the same as empty!).

Returns:

set of mappings known for this table function, or null if unknown (not the same as empty!)

getElementType

public @Nullable Type getElementType()

Returns element type of the collection that will implement this table.

Returns:

element type of the collection that will implement this table