Package org.apache.calcite.rel.metadata

Interface BuiltInMetadata.TableReferences

All Superinterfaces:

Metadata

Enclosing class:

BuiltInMetadata

public static interface BuiltInMetadata.TableReferences
extends Metadata

Metadata to obtain references to tables used by a given expression.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BuiltInMetadata.TableReferences.Handler	Handler API.

Field Summary

Fields

Modifier and Type	Field	Description
static final MetadataDef<BuiltInMetadata.TableReferences>	DEF

Method Summary

Modifier and Type	Method	Description
Set<RexTableInputRef.RelTableRef>	getTableReferences()	This provider returns the tables used by a given plan.

Methods inherited from interface org.apache.calcite.rel.metadata.Metadata

rel

Field Details

DEF

static final MetadataDef<BuiltInMetadata.TableReferences> DEF

Method Details

getTableReferences

Set<RexTableInputRef.RelTableRef> getTableReferences()

This provider returns the tables used by a given plan.

In particular, the result will be a set of unique table references (RexTableInputRef.RelTableRef) corresponding to each TableScan operator in the plan. These table references are composed by the table qualified name and an entity number.

Importantly, the table identifiers returned by this metadata provider will be consistent with the unique identifiers used by the BuiltInMetadata.ExpressionLineage provider, meaning that it is guaranteed that same table will use same unique identifiers in both.

Returns:

set of unique table identifiers, or null if this information cannot be determined