org.apache.calcite.prepare

Class CalcitePrepareImpl

java.lang.Object

org.apache.calcite.prepare.CalcitePrepareImpl

All Implemented Interfaces:

CalcitePrepare

public class CalcitePrepareImpl
extends Object
implements CalcitePrepare

Shit just got real.

This class is public so that projects that create their own JDBC driver and server can fine-tune preferences. However, this class and its methods are subject to change without notice.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.jdbc.CalcitePrepare

CalcitePrepare.CalciteSignature<T>, CalcitePrepare.Context, CalcitePrepare.ConvertResult, CalcitePrepare.Dummy, CalcitePrepare.ParseResult, CalcitePrepare.SparkHandler

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	COMMUTE
static boolean	DEBUG
static boolean	ENABLE_BINDABLE Whether the bindable convention should be the root convention of any plan.
static boolean	ENABLE_ENUMERABLE Whether the enumerable convention is enabled.
static boolean	ENABLE_STREAM Whether the streaming is enabled.

Fields inherited from interface org.apache.calcite.jdbc.CalcitePrepare

DEFAULT_FACTORY, THREAD_CONTEXT_STACK

Constructor Summary

Constructors

Constructor and Description
CalcitePrepareImpl()

Method Summary

Methods

Modifier and Type	Method and Description
CalcitePrepare.ConvertResult	convert(CalcitePrepare.Context context, String sql)
protected RelOptPlanner	createPlanner(CalcitePrepare.Context prepareContext) Creates a query planner and initializes it with a default set of rules.
protected RelOptPlanner	createPlanner(CalcitePrepare.Context prepareContext, Context externalContext, RelOptCostFactory costFactory) Creates a query planner and initializes it with a default set of rules.
protected List<Function1<CalcitePrepare.Context,RelOptPlanner>>	createPlannerFactories() Creates a collection of planner factories.
CalcitePrepare.ParseResult	parse(CalcitePrepare.Context context, String sql)
<R> R	perform(CalciteServerStatement statement, Frameworks.PrepareAction<R> action) Executes a prepare action.
protected void	populateMaterializations(CalcitePrepare.Context context, RelOptPlanner planner, Prepare.Materialization materialization)
<T> CalcitePrepare.CalciteSignature<T>	prepareQueryable(CalcitePrepare.Context context, Queryable<T> queryable)
<T> CalcitePrepare.CalciteSignature<T>	prepareSql(CalcitePrepare.Context context, String sql, Queryable<T> expression, Type elementType, int maxRowCount)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static final boolean DEBUG

COMMUTE

public static final boolean COMMUTE

ENABLE_BINDABLE

public static final boolean ENABLE_BINDABLE

Whether the bindable convention should be the root convention of any plan. If not, enumerable convention is the default.

See Also:

Constant Field Values

ENABLE_ENUMERABLE

public static final boolean ENABLE_ENUMERABLE

Whether the enumerable convention is enabled.

See Also:

Constant Field Values

ENABLE_STREAM

public static final boolean ENABLE_STREAM

Whether the streaming is enabled.

See Also:

Constant Field Values

Constructor Detail

CalcitePrepareImpl

public CalcitePrepareImpl()

Method Detail

parse

public CalcitePrepare.ParseResult parse(CalcitePrepare.Context context,
                               String sql)

Specified by:

parse in interface CalcitePrepare

convert

public CalcitePrepare.ConvertResult convert(CalcitePrepare.Context context,
                                   String sql)

Specified by:

convert in interface CalcitePrepare

createPlannerFactories

protected List<Function1<CalcitePrepare.Context,RelOptPlanner>> createPlannerFactories()

Creates a collection of planner factories.

The collection must have at least one factory, and each factory must create a planner. If the collection has more than one planner, Calcite will try each planner in turn.

One of the things you can do with this mechanism is to try a simpler, faster, planner with a smaller rule set first, then fall back to a more complex planner for complex and costly queries.

The default implementation returns a factory that calls createPlanner(org.apache.calcite.jdbc.CalcitePrepare.Context).

createPlanner

protected RelOptPlanner createPlanner(CalcitePrepare.Context prepareContext)

Creates a query planner and initializes it with a default set of rules.

createPlanner

protected RelOptPlanner createPlanner(CalcitePrepare.Context prepareContext,
                          Context externalContext,
                          RelOptCostFactory costFactory)

Creates a query planner and initializes it with a default set of rules.

prepareQueryable

public <T> CalcitePrepare.CalciteSignature<T> prepareQueryable(CalcitePrepare.Context context,
                                                      Queryable<T> queryable)

Specified by:

prepareQueryable in interface CalcitePrepare

prepareSql

public <T> CalcitePrepare.CalciteSignature<T> prepareSql(CalcitePrepare.Context context,
                                                String sql,
                                                Queryable<T> expression,
                                                Type elementType,
                                                int maxRowCount)

Specified by:

prepareSql in interface CalcitePrepare

populateMaterializations

protected void populateMaterializations(CalcitePrepare.Context context,
                            RelOptPlanner planner,
                            Prepare.Materialization materialization)

perform

public <R> R perform(CalciteServerStatement statement,
            Frameworks.PrepareAction<R> action)

Executes a prepare action.