java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.core.TableScan

All Implemented Interfaces:: Cloneable, RelOptNode, Hintable, RelNode

Direct Known Subclasses:: Bindables.BindableTableScan, CassandraTableScan, CsvTableScan, ElasticsearchTableScan, EnumerableTableScan, GeodeTableScan, JdbcTableScan, LogicalTableScan, MongoTableScan, PigTableScan, SplunkTableScan, StarTable.StarTableScan

public abstract class TableScan
extends AbstractRelNode
implements Hintable

Relational operator that returns the contents of a table.

Nested Class Summary

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

Fields

Modifier and Type Field Description

protected com.google.common.collect.ImmutableList<RelHint> hints
The table hints.

protected RelOptTable table
The table definition.

Fields inherited from class org.apache.calcite.rel.AbstractRelNode
digest, id, rowType, traitSet

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`TableScan(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelOptTable table)`
`protected`	`TableScan(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table)`	Deprecated.
`protected`	`TableScan(RelInput input)`	Creates a TableScan by parsing serialized output.

Method Summary

Modifier and Type	Method	Description
`RelNode`	`accept(RelShuttle shuttle)`	Accepts a visit from a shuttle.
`RelOptCost`	`computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq)`	Returns the cost of this plan (not including children).
`RelDataType`	`deriveRowType()`
`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.
`List<RelCollation>`	`getCollationList()`	Returns a description of the physical ordering (or orderings) of this relational expression.
`com.google.common.collect.ImmutableList<RelHint>`	`getHints()`	Returns the hints of this relational expressions as an immutable list.
`RelOptTable`	`getTable()`	If this relational expression represents an access to a table, returns that table, otherwise returns null.
`ImmutableIntList`	`identity()`	Returns an identity projection.
`static ImmutableIntList`	`identity(RelOptTable table)`	Returns an identity projection for the given table.
`RelNode`	`project(ImmutableBitSet fieldsUsed, Set<RelDataTypeField> extraFields, RelBuilder relBuilder)`	Projects a subset of the fields of the table, and also asks for "extra" fields that were not included in the table's official type.

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

accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeDigest, computeSelfCost, copy, equals, explain, getChildExps, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getInputs, getQuery, getRelTypeName, getRows, getRowType, getTraitSet, getVariablesSet, getVariablesStopped, hashCode, isDistinct, isEnforcer, isKey, isValid, isValid, metadata, onRegister, recomputeDigest, register, 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

Field Details
- table
  
  protected final RelOptTable table
  
  The table definition.
- hints
  
  protected final com.google.common.collect.ImmutableList<RelHint> hints
  
  The table hints.
Constructor Details
- TableScan
  
  protected TableScan(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelOptTable table)
- TableScan
  
  @Deprecated protected TableScan(RelOptCluster cluster, RelTraitSet traitSet, RelOptTable table)
  
  Deprecated.
- TableScan
  
  protected TableScan(RelInput input)
  
  Creates a TableScan by parsing serialized output.
Method Details
- 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
- 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
- getCollationList
  
  public List<RelCollation> getCollationList()
  
  Description copied from interface: RelNode
  
  Returns a description of the physical ordering (or orderings) of this relational expression. Never null.
  
  Specified by:
  
  getCollationList in interface RelNode
  
  Overrides:
  
  getCollationList in class AbstractRelNode
  
  Returns:
  
  Description of the physical ordering (or orderings) of this relational expression. Never null
- computeSelfCost
  
  public 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)
- deriveRowType
  
  public RelDataType deriveRowType()
  
  Overrides:
  
  deriveRowType in class AbstractRelNode
- identity
  
  public static ImmutableIntList identity(RelOptTable table)
  
  Returns an identity projection for the given table.
- identity
  
  public ImmutableIntList identity()
  
  Returns an identity projection.
- 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 RelWriterImpl.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
- project
  
  public RelNode project(ImmutableBitSet fieldsUsed, Set<RelDataTypeField> extraFields, RelBuilder relBuilder)
  
  Projects a subset of the fields of the table, and also asks for "extra" fields that were not included in the table's official type.
  The default implementation assumes that tables cannot do either of these operations, therefore it adds a Project that projects NULL values for the extra fields, using the RelBuilder.project(Iterable) method.
  Sub-classes, representing table types that have these capabilities, should override.
  
  Parameters:
  
  fieldsUsed - Bitmap of the fields desired by the consumer
  
  extraFields - Extra fields, not advertised in the table's row-type, wanted by the consumer
  
  relBuilder - Builder used to create a Project
  
  Returns:
  
  Relational expression that projects the desired fields
- accept
  
  public RelNode accept(RelShuttle shuttle)
  
  Description copied from interface: RelNode
  
  Accepts a visit from a shuttle.
  
  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
- getHints
  
  public com.google.common.collect.ImmutableList<RelHint> getHints()
  
  Description copied from interface: Hintable
  
  Returns the hints of this relational expressions as an immutable list.
  
  Specified by:
  
  getHints in interface Hintable

Modifier and Type	Field	Description
`protected com.google.common.collect.ImmutableList<RelHint>`	`hints`	The table hints.
`protected RelOptTable`	`table`	The table definition.

Class TableScan

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

Constructor Details

Method Details