org.apache.druid.sql.calcite.run

Interface SqlEngine

All Known Implementing Classes:

NativeSqlEngine, ViewSqlEngine

public interface SqlEngine

Engine for running SQL queries.

Method Summary

Modifier and Type	Method and Description
QueryMaker	buildQueryMakerForInsert(String targetDataSource, org.apache.calcite.rel.RelRoot relRoot, PlannerContext plannerContext) Create a QueryMaker for an INSERT ...
QueryMaker	buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot relRoot, PlannerContext plannerContext) Create a QueryMaker for a SELECT query.
boolean	feature(EngineFeature feature, PlannerContext plannerContext) Whether a feature applies to this engine or not.
String	name() Name of this engine.
org.apache.calcite.rel.type.RelDataType	resultTypeForInsert(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory, org.apache.calcite.rel.type.RelDataType validatedRowType) SQL row type that would be emitted by the QueryMaker from buildQueryMakerForInsert(java.lang.String, org.apache.calcite.rel.RelRoot, org.apache.druid.sql.calcite.planner.PlannerContext).
org.apache.calcite.rel.type.RelDataType	resultTypeForSelect(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory, org.apache.calcite.rel.type.RelDataType validatedRowType) SQL row type that would be emitted by the QueryMaker from buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot, org.apache.druid.sql.calcite.planner.PlannerContext).
void	validateContext(QueryContext queryContext) Validates a provided query context.

Method Detail

name

String name()

Name of this engine. Appears in user-visible messages.

feature

boolean feature(EngineFeature feature,
                PlannerContext plannerContext)

Whether a feature applies to this engine or not.

validateContext

void validateContext(QueryContext queryContext)
              throws org.apache.calcite.tools.ValidationException

Validates a provided query context. Returns quietly if the context is OK; throws ValidationException if the context has a problem.

Throws:

org.apache.calcite.tools.ValidationException

resultTypeForSelect

org.apache.calcite.rel.type.RelDataType resultTypeForSelect(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
                                                            org.apache.calcite.rel.type.RelDataType validatedRowType)

SQL row type that would be emitted by the QueryMaker from buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot, org.apache.druid.sql.calcite.planner.PlannerContext). Called for SELECT. Not called for EXPLAIN, which is handled by the planner itself.

Parameters:

typeFactory - type factory

validatedRowType - row type from Calcite's validator

resultTypeForInsert

org.apache.calcite.rel.type.RelDataType resultTypeForInsert(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
                                                            org.apache.calcite.rel.type.RelDataType validatedRowType)

SQL row type that would be emitted by the QueryMaker from buildQueryMakerForInsert(java.lang.String, org.apache.calcite.rel.RelRoot, org.apache.druid.sql.calcite.planner.PlannerContext). Called for INSERT and REPLACE. Not called for EXPLAIN, which is handled by the planner itself.

Parameters:

typeFactory - type factory

validatedRowType - row type from Calcite's validator

buildQueryMakerForSelect

QueryMaker buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot relRoot,
                                    PlannerContext plannerContext)
                             throws org.apache.calcite.tools.ValidationException

Create a QueryMaker for a SELECT query.

Parameters:

relRoot - planned and validated rel

plannerContext - context for this query

Returns:

an executor for the provided query

Throws:

org.apache.calcite.tools.ValidationException - if this engine cannot build an executor for the provided query

buildQueryMakerForInsert

QueryMaker buildQueryMakerForInsert(String targetDataSource,
                                    org.apache.calcite.rel.RelRoot relRoot,
                                    PlannerContext plannerContext)
                             throws org.apache.calcite.tools.ValidationException

Create a QueryMaker for an INSERT ... SELECT query.

Parameters:

targetDataSource - datasource for the INSERT portion of the query

relRoot - planned and validated rel for the SELECT portion of the query

plannerContext - context for this query

Returns:

an executor for the provided query

Throws:

org.apache.calcite.tools.ValidationException - if this engine cannot build an executor for the provided query