org.apache.calcite.prepare

Class Prepare

java.lang.Object

org.apache.calcite.prepare.Prepare

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 and Description
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, java.util.List<org.apache.calcite.prepare.Prepare.Materialization>, java.util.List<org.apache.calcite.jdbc.CalciteSchema.LatticeEntry>).
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 and Description
protected Prepare.CatalogReader	catalogReader
protected CalcitePrepare.Context	context
protected List<List<String>>	fieldOrigins
protected static Logger	LOGGER
protected RelDataType	parameterRowType
protected String	queryString
protected Convention	resultConvention Convention via which results should be returned by execution.
static ThreadLocal<Boolean>	THREAD_TRIM
protected CalciteTimingTracer	timingTracer

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Prepare.PreparedResult	createPreparedExplanation(RelDataType resultType, RelDataType parameterRowType, RelNode rootRel, boolean explainAsXml, SqlExplainLevel detailLevel)
protected abstract RelNode	decorrelate(SqlToRelConverter sqlToRelConverter, SqlNode query, RelNode rootRel)
RelNode	expandView(RelDataType rowType, String queryString, List<String> schemaPath) Returns a relational expression which is to be substituted for an access to a SQL view.
abstract RelNode	flattenTypes(RelNode rootRel, boolean restructure)
protected RelTraitSet	getDesiredRootTraitSet(RelNode rootRel)
protected abstract SqlToRelConverter	getSqlToRelConverter(SqlValidator validator, Prepare.CatalogReader catalogReader) Protected method to allow subclasses to override construction of SqlToRelConverter.
protected abstract SqlValidator	getSqlValidator()
protected abstract Prepare.PreparedResult	implement(RelDataType rowType, RelNode rootRel, SqlKind sqlKind) Implements a physical query plan.
protected abstract void	init(Class runtimeContextClass)
protected TableModify.Operation	mapTableModOp(boolean isDml, SqlKind sqlKind)
protected RelNode	optimize(RelNode rootRel, List<Prepare.Materialization> materializations, List<CalciteSchema.LatticeEntry> lattices) Optimizes a query plan.
Prepare.PreparedResult	prepareSql(SqlNode sqlQuery, Class runtimeContextClass, SqlValidator validator, boolean needsValidation, List<Prepare.Materialization> materializations, List<CalciteSchema.LatticeEntry> lattices)
Prepare.PreparedResult	prepareSql(SqlNode sqlQuery, SqlNode sqlNodeOriginal, Class runtimeContextClass, SqlValidator validator, boolean needsValidation, List<Prepare.Materialization> materializations, List<CalciteSchema.LatticeEntry> lattices)
protected RelNode	trimUnusedFields(RelNode rootRel) 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 Detail

LOGGER

protected static final Logger LOGGER

context

protected final CalcitePrepare.Context context

catalogReader

protected final Prepare.CatalogReader catalogReader

queryString

protected String queryString

resultConvention

protected final Convention resultConvention

Convention via which results should be returned by execution.

timingTracer

protected CalciteTimingTracer timingTracer

fieldOrigins

protected List<List<String>> fieldOrigins

parameterRowType

protected RelDataType parameterRowType

THREAD_TRIM

public static final ThreadLocal<Boolean> THREAD_TRIM

Constructor Detail

Prepare

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

Method Detail

createPreparedExplanation

protected abstract Prepare.PreparedResult createPreparedExplanation(RelDataType resultType,
                                               RelDataType parameterRowType,
                                               RelNode rootRel,
                                               boolean explainAsXml,
                                               SqlExplainLevel detailLevel)

optimize

protected RelNode optimize(RelNode rootRel,
               List<Prepare.Materialization> materializations,
               List<CalciteSchema.LatticeEntry> lattices)

Optimizes a query plan.

Parameters:

rootRel - root of a relational expression

materializations - Tables known to be populated with a given query

lattices - Lattices

Returns:

an equivalent optimized relational expression

getDesiredRootTraitSet

protected RelTraitSet getDesiredRootTraitSet(RelNode rootRel)

implement

protected abstract Prepare.PreparedResult implement(RelDataType rowType,
                               RelNode rootRel,
                               SqlKind sqlKind)

Implements a physical query plan.

Parameters:

rowType - original row type returned by query validator

rootRel - root of the relational expression.

sqlKind - SqlKind of the original statement.

Returns:

an executable plan

prepareSql

public Prepare.PreparedResult prepareSql(SqlNode sqlQuery,
                                Class runtimeContextClass,
                                SqlValidator validator,
                                boolean needsValidation,
                                List<Prepare.Materialization> materializations,
                                List<CalciteSchema.LatticeEntry> lattices)

prepareSql

public Prepare.PreparedResult prepareSql(SqlNode sqlQuery,
                                SqlNode sqlNodeOriginal,
                                Class runtimeContextClass,
                                SqlValidator validator,
                                boolean needsValidation,
                                List<Prepare.Materialization> materializations,
                                List<CalciteSchema.LatticeEntry> lattices)

mapTableModOp

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

getSqlToRelConverter

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

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)

trimUnusedFields

protected RelNode trimUnusedFields(RelNode rootRel)

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:

rootRel - Relational expression that is at the root of the tree

Returns:

Trimmed relational expression

expandView

public RelNode expandView(RelDataType rowType,
                 String queryString,
                 List<String> schemaPath)

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

Parameters:

rowType - Row type of the view

queryString - Body of the view

schemaPath - List of schema names wherein to find referenced tables

Returns:

Relational expression

init

protected abstract void init(Class runtimeContextClass)

getSqlValidator

protected abstract SqlValidator getSqlValidator()