Package 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

Modifier and Type	Class	Description
static class	CalcitePrepareImpl.CalcitePreparingStmt	Holds state for the process of preparing a SQL statement.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	ENABLE_ENUMERABLE	Deprecated.
static final boolean	ENABLE_STREAM	Deprecated.
final boolean	enableBindable	Whether the bindable convention should be the root convention of any plan.
static final List<RelOptRule>	ENUMERABLE_RULES	Deprecated.

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

DEFAULT_FACTORY, THREAD_CONTEXT_STACK

Constructor Summary

Constructors

Constructor	Description
CalcitePrepareImpl()

Method Summary

Modifier and Type	Method	Description
CalcitePrepare.AnalyzeViewResult	analyzeView(CalcitePrepare.Context context, String sql, boolean fail)	Analyzes a view.
CalcitePrepare.ConvertResult	convert(CalcitePrepare.Context context, String sql)
protected RelOptCluster	createCluster(RelOptPlanner planner, RexBuilder rexBuilder)	Factory method for cluster.
protected SqlRexConvertletTable	createConvertletTable()	Factory method for default convertlet table.
protected SqlParser	createParser(String sql)	Factory method for default SQL parser.
protected SqlParser	createParser(String sql, SqlParser.Config parserConfig)	Factory method for SQL parser with a given configuration.
protected SqlParser	createParser(String sql, SqlParser.ConfigBuilder parserConfig)	Deprecated.
protected SqlParser.ConfigBuilder	createParserConfig()	Deprecated.
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, @Nullable Context externalContext, @Nullable 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.
void	executeDdl(CalcitePrepare.Context context, SqlNode node)	Executes a DDL statement.
protected CalcitePrepareImpl.CalcitePreparingStmt	getPreparingStmt(CalcitePrepare.Context context, Type elementType, CalciteCatalogReader catalogReader, RelOptPlanner planner)	Returns CalcitePreparingStmt
CalcitePrepare.ParseResult	parse(CalcitePrepare.Context context, String sql)
protected SqlParser.Config	parserConfig()	Factory method for SQL parser configuration.
<R> R	perform(CalciteServerStatement statement, FrameworkConfig config, Frameworks.BasePrepareAction<R> action)	Executes a prepare action.
<R> R	perform(CalciteServerStatement statement, Frameworks.PrepareAction<R> action)	Deprecated.
protected void	populateMaterializations(CalcitePrepare.Context context, RelOptCluster cluster, Prepare.Materialization materialization)
<T> CalcitePrepare.CalciteSignature<T>	prepareQueryable(CalcitePrepare.Context context, Queryable<T> queryable)
<T> CalcitePrepare.CalciteSignature<T>	prepareSql(CalcitePrepare.Context context, CalcitePrepare.Query<T> query, Type elementType, long maxRowCount)

Methods inherited from class java.lang.Object

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

Field Details

ENABLE_ENUMERABLE

@Deprecated
public static final boolean ENABLE_ENUMERABLE

Deprecated.

ENABLE_STREAM

@Deprecated
public static final boolean ENABLE_STREAM

Deprecated.

ENUMERABLE_RULES

@Deprecated
public static final List<RelOptRule> ENUMERABLE_RULES

Deprecated.

enableBindable

public final boolean enableBindable

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

Constructor Details

CalcitePrepareImpl

public CalcitePrepareImpl()

Method Details

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

analyzeView

public CalcitePrepare.AnalyzeViewResult analyzeView(CalcitePrepare.Context context,
 String sql,
 boolean fail)

Description copied from interface: CalcitePrepare

Analyzes a view.

Specified by:

analyzeView in interface CalcitePrepare

Parameters:

context - Context

sql - View SQL

fail - Whether to fail (and throw a descriptive error message) if the view is not modifiable

Returns:

Result of analyzing the view

executeDdl

public void executeDdl(CalcitePrepare.Context context,
 SqlNode node)

Description copied from interface: CalcitePrepare

Executes a DDL statement.

The statement identified itself as DDL in the CalcitePrepare.ParseResult.kind() field.

Specified by:

executeDdl in interface CalcitePrepare

createParser

protected SqlParser createParser(String sql)

Factory method for default SQL parser.

createParser

protected SqlParser createParser(String sql,
 SqlParser.Config parserConfig)

Factory method for SQL parser with a given configuration.

createParser

@Deprecated
protected SqlParser createParser(String sql,
 SqlParser.ConfigBuilder parserConfig)

Deprecated.

parserConfig

protected SqlParser.Config parserConfig()

Factory method for SQL parser configuration.

createParserConfig

@Deprecated
protected SqlParser.ConfigBuilder createParserConfig()

Deprecated.

createConvertletTable

protected SqlRexConvertletTable createConvertletTable()

Factory method for default convertlet table.

createCluster

protected RelOptCluster createCluster(RelOptPlanner planner,
 RexBuilder rexBuilder)

Factory method for cluster.

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,
 @Nullable Context externalContext,
 @Nullable 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,
 CalcitePrepare.Query<T> query,
 Type elementType,
 long maxRowCount)

Specified by:

prepareSql in interface CalcitePrepare

getPreparingStmt

protected CalcitePrepareImpl.CalcitePreparingStmt getPreparingStmt(CalcitePrepare.Context context,
 Type elementType,
 CalciteCatalogReader catalogReader,
 RelOptPlanner planner)

Returns CalcitePreparingStmt

Override this function to return a custom CalcitePrepareImpl.CalcitePreparingStmt and createSqlValidator(org.apache.calcite.jdbc.CalcitePrepare.Context, org.apache.calcite.prepare.CalciteCatalogReader, java.util.function.UnaryOperator<org.apache.calcite.sql.validate.SqlValidator.Config>) to enable custom validation logic.

populateMaterializations

protected void populateMaterializations(CalcitePrepare.Context context,
 RelOptCluster cluster,
 Prepare.Materialization materialization)

perform

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

Deprecated.

perform

public <R> R perform(CalciteServerStatement statement,
 FrameworkConfig config,
 Frameworks.BasePrepareAction<R> action)

Executes a prepare action.