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 and Description
private static class	CalcitePrepareImpl.CalcitePreparedExplain An EXPLAIN statement, prepared and ready to execute.
(package private) static class	CalcitePrepareImpl.CalcitePreparingStmt Holds state for the process of preparing a SQL statement.
(package private) static class	CalcitePrepareImpl.EmptyScalarTranslator Basic translator.
private static class	CalcitePrepareImpl.LambdaScalarTranslator Translator that looks for parameters.
(package private) static interface	CalcitePrepareImpl.ScalarTranslator Translator from Java AST to RexNode.

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 and Description
static boolean	COMMUTE
private static List<RelOptRule>	CONSTANT_REDUCTION_RULES
static boolean	DEBUG
private static List<RelOptRule>	DEFAULT_RULES
private static boolean	ENABLE_COLLATION_TRAIT Whether to enable the collation trait.
static boolean	ENABLE_ENUMERABLE Whether the enumerable convention is enabled.
static boolean	ENABLE_STREAM Whether the streaming is enabled.
boolean	enableBindable Whether the bindable convention should be the root convention of any plan.
static List<RelOptRule>	ENUMERABLE_RULES
private static Set<String>	SIMPLE_SQLS

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

DEFAULT_FACTORY, THREAD_CONTEXT_STACK

Constructor Summary

Constructors

Constructor and Description
CalcitePrepareImpl()

Method Summary

Modifier and Type	Method and Description
private CalcitePrepare.AnalyzeViewResult	analyze_(SqlValidator validator, String sql, SqlNode sqlNode, RelRoot root, boolean fail)
CalcitePrepare.AnalyzeViewResult	analyzeView(CalcitePrepare.Context context, String sql, boolean fail) Analyzes a view.
private org.apache.calcite.avatica.ColumnMetaData.AvaticaType	avaticaType(JavaTypeFactory typeFactory, RelDataType type, RelDataType fieldType)
private CalcitePrepare.ParseResult	convert_(CalcitePrepare.Context context, String sql, boolean analyze, boolean fail, CalciteCatalogReader catalogReader, SqlValidator validator, SqlNode sqlNode1)
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.ConfigBuilder parserConfig) Factory method for SQL parser with a given configuration.
protected SqlParser.ConfigBuilder	createParserConfig() Factory method for SQL parser configuration.
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.
private SqlValidator	createSqlValidator(CalcitePrepare.Context context, CalciteCatalogReader catalogReader)
void	executeDdl(CalcitePrepare.Context context, SqlNode node) Executes a DDL statement.
private static String	getClassName(RelDataType type)
private List<org.apache.calcite.avatica.ColumnMetaData>	getColumnMetaDataList(JavaTypeFactory typeFactory, RelDataType x, RelDataType jdbcType, List<List<String>> originList)
private static int	getPrecision(RelDataType type)
private static int	getScale(RelDataType type)
private org.apache.calcite.avatica.Meta.StatementType	getStatementType(Prepare.PreparedResult preparedResult) Deduces the broad type of statement for a prepare result.
private org.apache.calcite.avatica.Meta.StatementType	getStatementType(SqlKind kind) Deduces the broad type of statement.
private static String	getTypeName(RelDataType type) Returns the type name in string form.
private int	getTypeOrdinal(RelDataType type)
private static RelDataType	makeStruct(RelDataTypeFactory typeFactory, RelDataType type)
private org.apache.calcite.avatica.ColumnMetaData	metaData(JavaTypeFactory typeFactory, int ordinal, String fieldName, RelDataType type, RelDataType fieldType, List<String> origins)
private static String	origin(List<String> origins, int offsetFromEnd)
private CalcitePrepare.ParseResult	parse_(CalcitePrepare.Context context, String sql, boolean convert, boolean analyze, boolean fail) Shared implementation for parse(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String), convert(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String) and analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String, boolean).
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)
(package private) <T> CalcitePrepare.CalciteSignature<T>	prepare_(CalcitePrepare.Context context, CalcitePrepare.Query<T> query, Type elementType, long maxRowCount)
(package private) <T> CalcitePrepare.CalciteSignature<T>	prepare2_(CalcitePrepare.Context context, CalcitePrepare.Query<T> query, Type elementType, long maxRowCount, CalciteCatalogReader catalogReader, RelOptPlanner planner)
<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)
private <T> CalcitePrepare.CalciteSignature<T>	simplePrepare(CalcitePrepare.Context context, String sql) Quickly prepares a simple SQL statement, circumventing the usual preparation process.

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_COLLATION_TRAIT

private static final boolean ENABLE_COLLATION_TRAIT

Whether to enable the collation trait. Some extra optimizations are possible if enabled, but queries should work either way. At some point this will become a preference, or we will run multiple phases: first disabled, then enabled.

See Also:

Constant Field Values

enableBindable

public final boolean enableBindable

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

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

SIMPLE_SQLS

private static final Set<String> SIMPLE_SQLS

ENUMERABLE_RULES

public static final List<RelOptRule> ENUMERABLE_RULES

DEFAULT_RULES

private static final List<RelOptRule> DEFAULT_RULES

CONSTANT_REDUCTION_RULES

private static final List<RelOptRule> CONSTANT_REDUCTION_RULES

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

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

parse_

private CalcitePrepare.ParseResult parse_(CalcitePrepare.Context context,
                                          String sql,
                                          boolean convert,
                                          boolean analyze,
                                          boolean fail)

Shared implementation for parse(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String), convert(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String) and analyzeView(org.apache.calcite.jdbc.CalcitePrepare.Context, java.lang.String, boolean).

convert_

private CalcitePrepare.ParseResult convert_(CalcitePrepare.Context context,
                                            String sql,
                                            boolean analyze,
                                            boolean fail,
                                            CalciteCatalogReader catalogReader,
                                            SqlValidator validator,
                                            SqlNode sqlNode1)

analyze_

private CalcitePrepare.AnalyzeViewResult analyze_(SqlValidator validator,
                                                  String sql,
                                                  SqlNode sqlNode,
                                                  RelRoot root,
                                                  boolean fail)

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.ConfigBuilder parserConfig)

Factory method for SQL parser with a given configuration.

createParserConfig

protected SqlParser.ConfigBuilder createParserConfig()

Factory method for SQL parser configuration.

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

Specified by:

prepareSql in interface CalcitePrepare

prepare_

<T> CalcitePrepare.CalciteSignature<T> prepare_(CalcitePrepare.Context context,
                                                CalcitePrepare.Query<T> query,
                                                Type elementType,
                                                long maxRowCount)

simplePrepare

private <T> CalcitePrepare.CalciteSignature<T> simplePrepare(CalcitePrepare.Context context,
                                                             String sql)

Quickly prepares a simple SQL statement, circumventing the usual preparation process.

getStatementType

private org.apache.calcite.avatica.Meta.StatementType getStatementType(SqlKind kind)

Deduces the broad type of statement. Currently returns SELECT for most statement types, but this may change.

Parameters:

kind - Kind of statement

getStatementType

private org.apache.calcite.avatica.Meta.StatementType getStatementType(Prepare.PreparedResult preparedResult)

Deduces the broad type of statement for a prepare result. Currently returns SELECT for most statement types, but this may change.

Parameters:

preparedResult - Prepare result

prepare2_

<T> CalcitePrepare.CalciteSignature<T> prepare2_(CalcitePrepare.Context context,
                                                 CalcitePrepare.Query<T> query,
                                                 Type elementType,
                                                 long maxRowCount,
                                                 CalciteCatalogReader catalogReader,
                                                 RelOptPlanner planner)

createSqlValidator

private SqlValidator createSqlValidator(CalcitePrepare.Context context,
                                        CalciteCatalogReader catalogReader)

getColumnMetaDataList

private List<org.apache.calcite.avatica.ColumnMetaData> getColumnMetaDataList(JavaTypeFactory typeFactory,
                                                                              RelDataType x,
                                                                              RelDataType jdbcType,
                                                                              List<List<String>> originList)

metaData

private org.apache.calcite.avatica.ColumnMetaData metaData(JavaTypeFactory typeFactory,
                                                           int ordinal,
                                                           String fieldName,
                                                           RelDataType type,
                                                           RelDataType fieldType,
                                                           List<String> origins)

avaticaType

private org.apache.calcite.avatica.ColumnMetaData.AvaticaType avaticaType(JavaTypeFactory typeFactory,
                                                                          RelDataType type,
                                                                          RelDataType fieldType)

origin

private static String origin(List<String> origins,
                             int offsetFromEnd)

getTypeOrdinal

private int getTypeOrdinal(RelDataType type)

getClassName

private static String getClassName(RelDataType type)

getScale

private static int getScale(RelDataType type)

getPrecision

private static int getPrecision(RelDataType type)

getTypeName

private static String getTypeName(RelDataType type)

Returns the type name in string form. Does not include precision, scale or whether nulls are allowed. Example: "DECIMAL" not "DECIMAL(7, 2)"; "INTEGER" not "JavaType(int)".

populateMaterializations

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

makeStruct

private static RelDataType makeStruct(RelDataTypeFactory typeFactory,
                                      RelDataType type)

perform

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

Executes a prepare action.