Package org.apache.calcite.prepare

Class CalcitePrepareImpl.CalcitePreparingStmt

java.lang.Object

org.apache.calcite.prepare.Prepare

org.apache.calcite.prepare.CalcitePrepareImpl.CalcitePreparingStmt

All Implemented Interfaces:

RelOptTable.ViewExpander

Enclosing class:

CalcitePrepareImpl

public static class CalcitePrepareImpl.CalcitePreparingStmt
extends Prepare
implements RelOptTable.ViewExpander

Holds state for the process of preparing a SQL statement.

Overload this class and createSqlValidator(org.apache.calcite.prepare.Prepare.CatalogReader) to provide desired SqlValidator and custom validation logic.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.prepare.Prepare

Prepare.AbstractPreparingTable, Prepare.CatalogReader, Prepare.Materialization, Prepare.PreparedExplain, Prepare.PreparedResult, Prepare.PreparedResultImpl, Prepare.PreparingTable

Field Summary

Fields

Modifier and Type	Field	Description
protected final SqlRexConvertletTable	convertletTable
protected final RelOptPlanner	planner
protected final CalcitePrepareImpl	prepare
protected final RexBuilder	rexBuilder
protected final CalciteSchema	schema
protected final RelDataTypeFactory	typeFactory

Fields inherited from class org.apache.calcite.prepare.Prepare

catalogReader, context, fieldOrigins, LOGGER, parameterRowType, resultConvention, THREAD_EXPAND, THREAD_INSUBQUERY_THRESHOLD, THREAD_TRIM, timingTracer

Constructor Summary

Constructors

Constructor	Description
CalcitePreparingStmt(CalcitePrepareImpl prepare, CalcitePrepare.Context context, Prepare.CatalogReader catalogReader, RelDataTypeFactory typeFactory, CalciteSchema schema, @Nullable EnumerableRel.Prefer prefer, RelOptCluster cluster, Convention resultConvention, SqlRexConvertletTable convertletTable)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected Prepare.PreparedResult	createPreparedExplanation(@Nullable RelDataType resultType, RelDataType parameterRowType, @Nullable RelRoot root, SqlExplainFormat format, SqlExplainLevel detailLevel)
protected SqlValidator	createSqlValidator(Prepare.CatalogReader catalogReader)
protected RelNode	decorrelate(SqlToRelConverter sqlToRelConverter, SqlNode query, RelNode rootRel)
RelRoot	expandView(RelDataType rowType, String queryString, List<String> schemaPath, @Nullable List<String> viewPath)	Returns a relational expression that is to be substituted for an access to a SQL view.
RelNode	flattenTypes(RelNode rootRel, boolean restructure)
protected List<CalciteSchema.LatticeEntry>	getLattices()
protected List<Prepare.Materialization>	getMaterializations()
protected SqlToRelConverter	getSqlToRelConverter(SqlValidator validator, Prepare.CatalogReader catalogReader, SqlToRelConverter.Config config)	Protected method to allow subclasses to override construction of SqlToRelConverter.
protected SqlValidator	getSqlValidator()
protected Prepare.PreparedResult	implement(RelRoot root)	Implements a physical query plan.
protected void	init(Class runtimeContextClass)
Prepare.PreparedResult	prepareQueryable(Queryable queryable, RelDataType resultType)
Prepare.PreparedResult	prepareRel(RelNode rel)

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

getDesiredRootTraitSet, getProgram, mapTableModOp, optimize, prepareSql, prepareSql, trimUnusedFields

Methods inherited from class java.lang.Object

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

Field Details

planner

protected final RelOptPlanner planner

rexBuilder

protected final RexBuilder rexBuilder

prepare

protected final CalcitePrepareImpl prepare

schema

protected final CalciteSchema schema

typeFactory

protected final RelDataTypeFactory typeFactory

convertletTable

protected final SqlRexConvertletTable convertletTable

Constructor Details

CalcitePreparingStmt

public CalcitePreparingStmt(CalcitePrepareImpl prepare,
 CalcitePrepare.Context context,
 Prepare.CatalogReader catalogReader,
 RelDataTypeFactory typeFactory,
 CalciteSchema schema,
 @Nullable EnumerableRel.Prefer prefer,
 RelOptCluster cluster,
 Convention resultConvention,
 SqlRexConvertletTable convertletTable)

Constructor.

Overload this constructor and createSqlValidator(org.apache.calcite.prepare.Prepare.CatalogReader) to provide desired SqlValidator and custom validation logic.

Method Details

init

protected void init(Class runtimeContextClass)

Specified by:

init in class Prepare

prepareQueryable

public Prepare.PreparedResult prepareQueryable(Queryable queryable,
 RelDataType resultType)

prepareRel

public Prepare.PreparedResult prepareRel(RelNode rel)

getSqlToRelConverter

protected SqlToRelConverter getSqlToRelConverter(SqlValidator validator,
 Prepare.CatalogReader catalogReader,
 SqlToRelConverter.Config config)

Description copied from class: Prepare

Protected method to allow subclasses to override construction of SqlToRelConverter.

Specified by:

getSqlToRelConverter in class Prepare

flattenTypes

public RelNode flattenTypes(RelNode rootRel,
 boolean restructure)

Specified by:

flattenTypes in class Prepare

decorrelate

protected RelNode decorrelate(SqlToRelConverter sqlToRelConverter,
 SqlNode query,
 RelNode rootRel)

Specified by:

decorrelate in class Prepare

expandView

public RelRoot expandView(RelDataType rowType,
 String queryString,
 List<String> schemaPath,
 @Nullable List<String> viewPath)

Description copied from interface: RelOptTable.ViewExpander

Returns a relational expression that is to be substituted for an access to a SQL view.

Specified by:

expandView in interface RelOptTable.ViewExpander

Parameters:

rowType - Row type of the view

queryString - Body of the view

schemaPath - Path of a schema wherein to find referenced tables

viewPath - Path of the view, ending with its name; may be null

Returns:

Relational expression

createSqlValidator

protected SqlValidator createSqlValidator(Prepare.CatalogReader catalogReader)

getSqlValidator

protected SqlValidator getSqlValidator()

Specified by:

getSqlValidator in class Prepare

createPreparedExplanation

protected Prepare.PreparedResult createPreparedExplanation(@Nullable RelDataType resultType,
 RelDataType parameterRowType,
 @Nullable RelRoot root,
 SqlExplainFormat format,
 SqlExplainLevel detailLevel)

Specified by:

createPreparedExplanation in class Prepare

implement

protected Prepare.PreparedResult implement(RelRoot root)

Description copied from class: Prepare

Implements a physical query plan.

Specified by:

implement in class Prepare

Parameters:

root - Root of the relational expression tree

Returns:

an executable plan

getMaterializations

protected List<Prepare.Materialization> getMaterializations()

Specified by:

getMaterializations in class Prepare

getLattices

protected List<CalciteSchema.LatticeEntry> getLattices()

Specified by:

getLattices in class Prepare