Package org.apache.calcite.rel.core

Class TableModify

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.TableModify

All Implemented Interfaces:

Cloneable, RelOptNode, RelNode

Direct Known Subclasses:

EnumerableTableModify, JdbcRules.JdbcTableModify, LogicalTableModify

public abstract class TableModify
extends SingleRel

Relational expression that modifies a table.

It is similar to TableScan, but represents a request to modify a table rather than read from it. It takes one child which produces the modified rows. Those rows are:

• For INSERT, those rows are the new values;
• for DELETE, the old values;
• for UPDATE, all old values plus updated new values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TableModify.Operation	Enumeration of supported modification operations.

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

RelNode.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected Prepare.CatalogReader	catalogReader	The connection to the optimizing session.
protected final RelOptTable	table	The table definition.

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

Modifier	Constructor	Description
protected	TableModify(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table, Prepare.CatalogReader catalogReader, RelNode input, TableModify.Operation operation, @Nullable List<String> updateColumnList, @Nullable List<RexNode> sourceExpressionList, boolean flattened)	Creates a TableModify.
protected	TableModify(RelInput input)	Creates a TableModify by parsing serialized output.

Method Summary

Modifier and Type	Method	Description
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)	Returns the cost of this plan (not including children).
RelDataType	deriveRowType()
RelWriter	explainTerms(RelWriter pw)	Describes the inputs and attributes of this relational expression.
Prepare.CatalogReader	getCatalogReader()
RelDataType	getExpectedInputRowType(int ordinalInParent)	Returns the type of the rows expected for an input.
TableModify.Operation	getOperation()
@Nullable List<RexNode>	getSourceExpressionList()
RelOptTable	getTable()	If this relational expression represents an access to a table, returns that table, otherwise returns null.
@Nullable List<String>	getUpdateColumnList()
boolean	isDelete()
boolean	isFlattened()
boolean	isInsert()
boolean	isMerge()
boolean	isUpdate()

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

childrenAccept, estimateRowCount, getInput, getInputs, replaceInput

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

accept, accept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getId, getInput, getRelDigest, getRelTypeName, getRowType, 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, stripped

Field Details

catalogReader

protected Prepare.CatalogReader catalogReader

The connection to the optimizing session.

table

protected final RelOptTable table

The table definition.

Constructor Details

TableModify

protected TableModify(RelOptCluster cluster,
 RelTraitSet traitSet,
 RelOptTable table,
 Prepare.CatalogReader catalogReader,
 RelNode input,
 TableModify.Operation operation,
 @Nullable List<String> updateColumnList,
 @Nullable List<RexNode> sourceExpressionList,
 boolean flattened)

Creates a TableModify.

The UPDATE operation has format like this:

UPDATE table SET iden1 = exp1, ident2 = exp2  WHERE condition

Parameters:

cluster - Cluster this relational expression belongs to

traitSet - Traits of this relational expression

table - Target table to modify

catalogReader - accessor to the table metadata.

input - Sub-query or filter condition

operation - Modify operation (INSERT, UPDATE, DELETE)

updateColumnList - List of column identifiers to be updated (e.g. ident1, ident2); null if not UPDATE

sourceExpressionList - List of value expressions to be set (e.g. exp1, exp2); null if not UPDATE

flattened - Whether set flattens the input row type

TableModify

protected TableModify(RelInput input)

Creates a TableModify by parsing serialized output.

Method Details

getCatalogReader

public Prepare.CatalogReader getCatalogReader()

getTable

public RelOptTable getTable()

Description copied from interface: RelNode

If this relational expression represents an access to a table, returns that table, otherwise returns null.

Specified by:

getTable in interface RelNode

Overrides:

getTable in class AbstractRelNode

Returns:

If this relational expression represents an access to a table, returns that table, otherwise returns null

getUpdateColumnList

public @Nullable List<String> getUpdateColumnList()

getSourceExpressionList

public @Nullable List<RexNode> getSourceExpressionList()

isFlattened

public boolean isFlattened()

getOperation

public TableModify.Operation getOperation()

isInsert

public boolean isInsert()

isUpdate

public boolean isUpdate()

isDelete

public boolean isDelete()

isMerge

public boolean isMerge()

deriveRowType

public RelDataType deriveRowType()

Overrides:

deriveRowType in class SingleRel

getExpectedInputRowType

public RelDataType getExpectedInputRowType(int ordinalInParent)

Description copied from interface: RelNode

Returns the type of the rows expected for an input. Defaults to RelNode.getRowType().

Specified by:

getExpectedInputRowType in interface RelNode

Overrides:

getExpectedInputRowType in class AbstractRelNode

Parameters:

ordinalInParent - input's 0-based ordinal with respect to this parent rel

Returns:

expected row type

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

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 AbstractRelNode

Parameters:

planner - Planner for cost calculation

mq - Metadata query

Returns:

Cost of this plan (not including children)