org.apache.calcite.prepare

Class RelOptTableImpl

java.lang.Object

org.apache.calcite.prepare.Prepare.AbstractPreparingTable

org.apache.calcite.prepare.RelOptTableImpl

All Implemented Interfaces:

RelOptTable, Prepare.PreparingTable, Wrapper, SqlValidatorTable

public class RelOptTableImpl
extends Prepare.AbstractPreparingTable

Implementation of RelOptTable.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.plan.RelOptTable

RelOptTable.ToRelContext, RelOptTable.ViewExpander

Method Summary

Modifier and Type	Method and Description
static List<ColumnStrategy>	columnStrategies(RelOptTable table) Helper for Prepare.AbstractPreparingTable.getColumnStrategies().
RelOptTableImpl	copy(RelDataType newRowType) Creates a copy of this RelOptTable.
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, CalciteSchema.TableEntry tableEntry, @Nullable Double rowCount)
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, List<String> names, org.apache.calcite.linq4j.tree.Expression expression)
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, List<String> names, Table table, org.apache.calcite.linq4j.tree.Expression expression) Deprecated.
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, List<String> names, Table table, org.apache.calcite.linq4j.tree.TableExpressionFactory expressionFactory) Creates RelOptTableImpl instance with specified arguments and row count obtained from table statistic.
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, Table table, com.google.common.collect.ImmutableList<String> names)
static RelOptTableImpl	create(@Nullable RelOptSchema schema, RelDataType rowType, Table table, Path path)
boolean	equals(@Nullable Object obj)
protected RelOptTable	extend(Table extendedTable) Implementation-specific code to instantiate a new RelOptTable based on a Table that has been extended.
SqlAccessType	getAllowedAccess() Returns the access type of the table.
@Nullable List<RelCollation>	getCollationList() Returns a description of the physical ordering (or orderings) of the rows returned from this table.
@Nullable RelDistribution	getDistribution() Returns a description of the physical distribution of the rows in this table.
@Nullable org.apache.calcite.linq4j.tree.Expression	getExpression(Class clazz) Generates code for this table.
@Nullable List<ImmutableBitSet>	getKeys() Returns a list of unique keys, empty list if no key exist, the result should be consistent with isKey.
SqlMonotonicity	getMonotonicity(String columnName) Returns whether a given column is monotonic.
List<String>	getQualifiedName() Obtains an identifier for this table.
@Nullable List<RelReferentialConstraint>	getReferentialConstraints() Returns the referential constraints existing for this table.
@Nullable RelOptSchema	getRelOptSchema() Returns the RelOptSchema this table belongs to.
double	getRowCount() Returns an estimate of the number of rows in the table.
RelDataType	getRowType() Describes the type of rows returned by this table.
int	hashCode()
boolean	isKey(ImmutableBitSet columns) Returns whether the given columns are a key or a superset of a unique key of this table.
boolean	isTemporal() Returns whether the table is temporal.
static int	realOrdinal(RelOptTable table, int i) Converts the ordinal of a field into the ordinal of a stored field.
static RelDataType	realRowType(RelOptTable table) Returns the row type of a table after any ColumnStrategy.VIRTUAL columns have been removed.
boolean	supportsModality(SqlModality modality)
RelNode	toRel(RelOptTable.ToRelContext context) Converts this table into a relational expression.
String	toString()
<T> T	unwrap(Class<T> clazz) Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

Methods inherited from class org.apache.calcite.prepare.Prepare.AbstractPreparingTable

columnHasDefaultValue, extend, getColumnStrategies

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.sql.validate.SqlValidatorTable

table

Methods inherited from interface org.apache.calcite.schema.Wrapper

maybeUnwrap, unwrapOrThrow

Method Detail

create

public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                     RelDataType rowType,
                                     List<String> names,
                                     org.apache.calcite.linq4j.tree.Expression expression)

create

@Deprecated
public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                                 RelDataType rowType,
                                                 List<String> names,
                                                 Table table,
                                                 org.apache.calcite.linq4j.tree.Expression expression)

Deprecated.

create

public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                     RelDataType rowType,
                                     List<String> names,
                                     Table table,
                                     org.apache.calcite.linq4j.tree.TableExpressionFactory expressionFactory)

Creates RelOptTableImpl instance with specified arguments and row count obtained from table statistic.

Parameters:

schema - table schema

rowType - table row type

names - full table path

table - table

expressionFactory - expression function for accessing table data in the generated code

Returns:

RelOptTableImpl instance

create

public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                     RelDataType rowType,
                                     Table table,
                                     Path path)

create

public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                     RelDataType rowType,
                                     CalciteSchema.TableEntry tableEntry,
                                     @Nullable Double rowCount)

copy

public RelOptTableImpl copy(RelDataType newRowType)

Creates a copy of this RelOptTable. The new RelOptTable will have newRowType.

toString

public String toString()

Overrides:

toString in class Object

create

public static RelOptTableImpl create(@Nullable RelOptSchema schema,
                                     RelDataType rowType,
                                     Table table,
                                     com.google.common.collect.ImmutableList<String> names)

unwrap

public <T> T unwrap(Class<T> clazz)

Description copied from interface: Wrapper

Finds an instance of an interface implemented by this object, or returns null if this object does not support that interface.

getExpression

public @Nullable org.apache.calcite.linq4j.tree.Expression getExpression(Class clazz)

Description copied from interface: RelOptTable

Generates code for this table.

Parameters:

clazz - The desired collection class; for example Queryable.

Returns:

the code for the table, or null if code generation is not supported

extend

protected RelOptTable extend(Table extendedTable)

Description copied from class: Prepare.AbstractPreparingTable

Implementation-specific code to instantiate a new RelOptTable based on a Table that has been extended.

Specified by:

extend in class Prepare.AbstractPreparingTable

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRowCount

public double getRowCount()

Description copied from interface: RelOptTable

Returns an estimate of the number of rows in the table.

getRelOptSchema

public @Nullable RelOptSchema getRelOptSchema()

Description copied from interface: RelOptTable

Returns the RelOptSchema this table belongs to.

toRel

public RelNode toRel(RelOptTable.ToRelContext context)

Description copied from interface: RelOptTable

Converts this table into a relational expression.

The planner calls this method to convert a table into an initial relational expression, generally something abstract, such as a LogicalTableScan, then optimizes this expression by applying rules to transform it into more efficient access methods for this table.

getCollationList

public @Nullable List<RelCollation> getCollationList()

Description copied from interface: RelOptTable

Returns a description of the physical ordering (or orderings) of the rows returned from this table.

See Also:

RelMetadataQuery.collations(RelNode)

getDistribution

public @Nullable RelDistribution getDistribution()

Description copied from interface: RelOptTable

Returns a description of the physical distribution of the rows in this table.

See Also:

RelMetadataQuery.distribution(RelNode)

isKey

public boolean isKey(ImmutableBitSet columns)

Description copied from interface: RelOptTable

Returns whether the given columns are a key or a superset of a unique key of this table.

Parameters:

columns - Ordinals of key columns

Returns:

Whether the given columns are a key or a superset of a key

getKeys

public @Nullable List<ImmutableBitSet> getKeys()

Description copied from interface: RelOptTable

Returns a list of unique keys, empty list if no key exist, the result should be consistent with isKey.

getReferentialConstraints

public @Nullable List<RelReferentialConstraint> getReferentialConstraints()

Description copied from interface: RelOptTable

Returns the referential constraints existing for this table. These constraints are represented over other tables using RelReferentialConstraint nodes.

getRowType

public RelDataType getRowType()

Description copied from interface: RelOptTable

Describes the type of rows returned by this table.

supportsModality

public boolean supportsModality(SqlModality modality)

isTemporal

public boolean isTemporal()

Description copied from interface: SqlValidatorTable

Returns whether the table is temporal.

getQualifiedName

public List<String> getQualifiedName()

Description copied from interface: RelOptTable

Obtains an identifier for this table. The identifier must be unique with respect to the Connection producing this table.

Returns:

qualified name

getMonotonicity

public SqlMonotonicity getMonotonicity(String columnName)

Description copied from interface: SqlValidatorTable

Returns whether a given column is monotonic.

getAllowedAccess

public SqlAccessType getAllowedAccess()

Description copied from interface: SqlValidatorTable

Returns the access type of the table.

columnStrategies

public static List<ColumnStrategy> columnStrategies(RelOptTable table)

Helper for Prepare.AbstractPreparingTable.getColumnStrategies().

realOrdinal

public static int realOrdinal(RelOptTable table,
                              int i)

Converts the ordinal of a field into the ordinal of a stored field. That is, it subtracts the number of virtual fields that come before it.

realRowType

public static RelDataType realRowType(RelOptTable table)

Returns the row type of a table after any ColumnStrategy.VIRTUAL columns have been removed. This is the type of the records that are actually stored.