org.apache.calcite.rel.metadata

Class RelMdTableReferences

java.lang.Object

org.apache.calcite.rel.metadata.RelMdTableReferences

All Implemented Interfaces:

MetadataHandler<BuiltInMetadata.TableReferences>

public class RelMdTableReferences
extends Object
implements MetadataHandler<BuiltInMetadata.TableReferences>

Default implementation of RelMetadataQuery.getTableReferences(org.apache.calcite.rel.RelNode) for the standard logical algebra.

The goal of this provider is to return all tables used by a given expression identified uniquely by a RexTableInputRef.RelTableRef.

Each unique identifier RexTableInputRef.RelTableRef of a table will equal to the identifier obtained running RelMdExpressionLineage over the same plan node for an expression that refers to the same table.

If tables cannot be obtained, we return null.

Field Summary

Fields

Modifier and Type	Field and Description
static RelMetadataProvider	SOURCE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RelMdTableReferences()

Method Summary

Modifier and Type	Method and Description
MetadataDef<BuiltInMetadata.TableReferences>	getDef()
Set<RexTableInputRef.RelTableRef>	getTableReferences(Aggregate rel, RelMetadataQuery mq) Table references from Aggregate.
Set<RexTableInputRef.RelTableRef>	getTableReferences(Exchange rel, RelMetadataQuery mq) Table references from Exchange.
Set<RexTableInputRef.RelTableRef>	getTableReferences(Filter rel, RelMetadataQuery mq) Table references from Filter.
Set<RexTableInputRef.RelTableRef>	getTableReferences(HepRelVertex rel, RelMetadataQuery mq)
Set<RexTableInputRef.RelTableRef>	getTableReferences(Join rel, RelMetadataQuery mq) Table references from Join.
Set<RexTableInputRef.RelTableRef>	getTableReferences(Project rel, RelMetadataQuery mq) Table references from Project.
Set<RexTableInputRef.RelTableRef>	getTableReferences(RelNode rel, RelMetadataQuery mq)
Set<RexTableInputRef.RelTableRef>	getTableReferences(RelSubset rel, RelMetadataQuery mq)
Set<RexTableInputRef.RelTableRef>	getTableReferences(Sort rel, RelMetadataQuery mq) Table references from Sort.
Set<RexTableInputRef.RelTableRef>	getTableReferences(TableScan rel, RelMetadataQuery mq) TableScan table reference.
Set<RexTableInputRef.RelTableRef>	getTableReferences(Union rel, RelMetadataQuery mq) Table references from Union.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SOURCE

public static final RelMetadataProvider SOURCE

Constructor Detail

RelMdTableReferences

private RelMdTableReferences()

Method Detail

getDef

public MetadataDef<BuiltInMetadata.TableReferences> getDef()

Specified by:

getDef in interface MetadataHandler<BuiltInMetadata.TableReferences>

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(RelNode rel,
                                                            RelMetadataQuery mq)

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(HepRelVertex rel,
                                                            RelMetadataQuery mq)

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(RelSubset rel,
                                                            RelMetadataQuery mq)

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(TableScan rel,
                                                            RelMetadataQuery mq)

TableScan table reference.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Aggregate rel,
                                                            RelMetadataQuery mq)

Table references from Aggregate.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Join rel,
                                                            RelMetadataQuery mq)

Table references from Join.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Union rel,
                                                            RelMetadataQuery mq)

Table references from Union.

For Union operator, we might be able to extract multiple table references.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Project rel,
                                                            RelMetadataQuery mq)

Table references from Project.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Filter rel,
                                                            RelMetadataQuery mq)

Table references from Filter.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Sort rel,
                                                            RelMetadataQuery mq)

Table references from Sort.

getTableReferences

public Set<RexTableInputRef.RelTableRef> getTableReferences(Exchange rel,
                                                            RelMetadataQuery mq)

Table references from Exchange.