Package org.apache.calcite.prepare

Class Prepare

java.lang.Object

org.apache.calcite.prepare.Prepare

Direct Known Subclasses:

CalcitePrepareImpl.CalcitePreparingStmt

public abstract class Prepare
extends Object

Abstract base for classes that implement the process of preparing and executing SQL expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Prepare.AbstractPreparingTable	Abstract implementation of Prepare.PreparingTable with an implementation for Prepare.AbstractPreparingTable.columnHasDefaultValue(org.apache.calcite.rel.type.RelDataType, int, org.apache.calcite.sql2rel.InitializerContext).
static interface	Prepare.CatalogReader	Interface by which validator and planner can read table metadata.
static class	Prepare.Materialization	Describes that a given SQL query is materialized by a given table.
static class	Prepare.PreparedExplain	PreparedExplanation is a PreparedResult for an EXPLAIN PLAN statement.
static interface	Prepare.PreparedResult	Result of a call to prepareSql(org.apache.calcite.sql.SqlNode, java.lang.Class, org.apache.calcite.sql.validate.SqlValidator, boolean).
static class	Prepare.PreparedResultImpl	Abstract implementation of Prepare.PreparedResult.
static interface	Prepare.PreparingTable	Definition of a table, for the purposes of the validator and planner.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Prepare.CatalogReader	catalogReader
protected final CalcitePrepare.Context	context
protected @MonotonicNonNull List<@Nullable List<String>>	fieldOrigins
protected static final org.slf4j.Logger	LOGGER
protected @MonotonicNonNull RelDataType	parameterRowType
protected final Convention	resultConvention	Convention via which results should be returned by execution.
static final TryThreadLocal<Boolean>	THREAD_EXPAND	Temporary, until [CALCITE-1045] Decorrelate sub-queries in Project and Join is fixed.
static final TryThreadLocal<@Nullable Integer>	THREAD_INSUBQUERY_THRESHOLD
static final TryThreadLocal<Boolean>	THREAD_TRIM
protected @Nullable CalciteTimingTracer	timingTracer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Prepare(CalcitePrepare.Context context, Prepare.CatalogReader catalogReader, Convention resultConvention)

Method Summary

Modifier and Type	Method	Description
protected abstract Prepare.PreparedResult	createPreparedExplanation(@Nullable RelDataType resultType, RelDataType parameterRowType, @Nullable RelRoot root, SqlExplainFormat format, SqlExplainLevel detailLevel)
protected abstract RelNode	decorrelate(SqlToRelConverter sqlToRelConverter, SqlNode query, RelNode rootRel)
abstract RelNode	flattenTypes(RelNode rootRel, boolean restructure)
protected RelTraitSet	getDesiredRootTraitSet(RelRoot root)
protected abstract List<CalciteSchema.LatticeEntry>	getLattices()
protected abstract List<Prepare.Materialization>	getMaterializations()
protected Program	getProgram()
protected abstract SqlToRelConverter	getSqlToRelConverter(SqlValidator validator, Prepare.CatalogReader catalogReader, SqlToRelConverter.Config config)	Protected method to allow subclasses to override construction of SqlToRelConverter.
protected abstract SqlValidator	getSqlValidator()
protected abstract Prepare.PreparedResult	implement(RelRoot root)	Implements a physical query plan.
protected abstract void	init(Class runtimeContextClass)
protected @Nullable TableModify.Operation	mapTableModOp(boolean isDml, SqlKind sqlKind)
protected RelRoot	optimize(RelRoot root, List<Prepare.Materialization> materializations, List<CalciteSchema.LatticeEntry> lattices)	Optimizes a query plan.
Prepare.PreparedResult	prepareSql(SqlNode sqlQuery, Class runtimeContextClass, SqlValidator validator, boolean needsValidation)
Prepare.PreparedResult	prepareSql(SqlNode sqlQuery, SqlNode sqlNodeOriginal, Class<?> runtimeContextClass, SqlValidator validator, boolean needsValidation)
protected RelRoot	trimUnusedFields(RelRoot root)	Walks over a tree of relational expressions, replacing each RelNode with a 'slimmed down' relational expression that projects only the columns required by its consumer.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

protected static final org.slf4j.Logger LOGGER

context

protected final CalcitePrepare.Context context

catalogReader

protected final Prepare.CatalogReader catalogReader

resultConvention

protected final Convention resultConvention

Convention via which results should be returned by execution.

timingTracer

protected @Nullable CalciteTimingTracer timingTracer

fieldOrigins

protected @MonotonicNonNull List<@Nullable List<String>> fieldOrigins

parameterRowType

protected @MonotonicNonNull RelDataType parameterRowType

THREAD_TRIM

public static final TryThreadLocal<Boolean> THREAD_TRIM

THREAD_EXPAND

public static final TryThreadLocal<Boolean> THREAD_EXPAND

Temporary, until [CALCITE-1045] Decorrelate sub-queries in Project and Join is fixed.

The default is false, meaning do not expand queries during sql-to-rel, but a few tests override and set it to true. After CALCITE-1045 is fixed, remove those overrides and use false everywhere.

THREAD_INSUBQUERY_THRESHOLD

public static final TryThreadLocal<@Nullable Integer> THREAD_INSUBQUERY_THRESHOLD

Constructor Details

Prepare

protected Prepare(CalcitePrepare.Context context,
 Prepare.CatalogReader catalogReader,
 Convention resultConvention)

Method Details

createPreparedExplanation

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

optimize

protected RelRoot optimize(RelRoot root,
 List<Prepare.Materialization> materializations,
 List<CalciteSchema.LatticeEntry> lattices)

Optimizes a query plan.

Parameters:

root - Root of relational expression tree

materializations - Tables known to be populated with a given query

lattices - Lattices

Returns:

an equivalent optimized relational expression

getProgram

protected Program getProgram()

getDesiredRootTraitSet

protected RelTraitSet getDesiredRootTraitSet(RelRoot root)

implement

protected abstract Prepare.PreparedResult implement(RelRoot root)

Implements a physical query plan.

Parameters:

root - Root of the relational expression tree

Returns:

an executable plan

prepareSql

public Prepare.PreparedResult prepareSql(SqlNode sqlQuery,
 Class runtimeContextClass,
 SqlValidator validator,
 boolean needsValidation)

prepareSql

public Prepare.PreparedResult prepareSql(SqlNode sqlQuery,
 SqlNode sqlNodeOriginal,
 Class<?> runtimeContextClass,
 SqlValidator validator,
 boolean needsValidation)

mapTableModOp

protected @Nullable TableModify.Operation mapTableModOp(boolean isDml,
 SqlKind sqlKind)

getSqlToRelConverter

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

Protected method to allow subclasses to override construction of SqlToRelConverter.

flattenTypes

public abstract RelNode flattenTypes(RelNode rootRel,
 boolean restructure)

decorrelate

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

getMaterializations

protected abstract List<Prepare.Materialization> getMaterializations()

getLattices

protected abstract List<CalciteSchema.LatticeEntry> getLattices()

trimUnusedFields

protected RelRoot trimUnusedFields(RelRoot root)

Walks over a tree of relational expressions, replacing each RelNode with a 'slimmed down' relational expression that projects only the columns required by its consumer.

Parameters:

root - Root of relational expression tree

Returns:

Trimmed relational expression

init

protected abstract void init(Class runtimeContextClass)

getSqlValidator

protected abstract SqlValidator getSqlValidator()