Package org.apache.druid.sql.calcite.run

Class NativeSqlEngine

java.lang.Object

org.apache.druid.sql.calcite.run.NativeSqlEngine

All Implemented Interfaces:

SqlEngine

public class NativeSqlEngine
extends Object
implements SqlEngine

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final Set<String>	SYSTEM_CONTEXT_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
NativeSqlEngine(QueryLifecycleFactory queryLifecycleFactory, com.fasterxml.jackson.databind.ObjectMapper jsonMapper, SqlStatementFactory sqlStatementFactory)
NativeSqlEngine(QueryLifecycleFactory queryLifecycleFactory, com.fasterxml.jackson.databind.ObjectMapper jsonMapper, SqlToolbox toolbox)

Method Summary

Modifier and Type	Method	Description
QueryMaker	buildQueryMakerForInsert(IngestDestination destination, 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.
void	cancelQuery(PlannerContext plannerContext, QueryScheduler queryScheduler)	Cancels a currently running query given the PlannerContext for the query.
boolean	featureAvailable(EngineFeature feature)	Whether a feature applies to this engine or not.
SqlStatementFactory	getSqlStatementFactory()	Returns a SqlStatementFactory which uses this engine to create statements.
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, Map<String,Object> queryContext)	SQL row type that would be emitted by the QueryMaker from SqlEngine.buildQueryMakerForInsert(org.apache.druid.sql.destination.IngestDestination, 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, Map<String,Object> queryContext)	SQL row type that would be emitted by the QueryMaker from SqlEngine.buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot, org.apache.druid.sql.calcite.planner.PlannerContext).
void	validateContext(Map<String,Object> queryContext)	Validates a provided query context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.sql.calcite.run.SqlEngine

getQueries, getQueryReport, initContextMap

Field Details

SYSTEM_CONTEXT_PARAMETERS

public static final Set<String> SYSTEM_CONTEXT_PARAMETERS

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

NativeSqlEngine

@Inject
public NativeSqlEngine(QueryLifecycleFactory queryLifecycleFactory,
 com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 SqlToolbox toolbox)

NativeSqlEngine

public NativeSqlEngine(QueryLifecycleFactory queryLifecycleFactory,
 com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 SqlStatementFactory sqlStatementFactory)

Method Details

name

public String name()

Description copied from interface: SqlEngine

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

Specified by:

name in interface SqlEngine

validateContext

public void validateContext(Map<String,Object> queryContext)

Description copied from interface: SqlEngine

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

Specified by:

validateContext in interface SqlEngine

resultTypeForSelect

public org.apache.calcite.rel.type.RelDataType resultTypeForSelect(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
 org.apache.calcite.rel.type.RelDataType validatedRowType,
 Map<String,Object> queryContext)

Description copied from interface: SqlEngine

SQL row type that would be emitted by the QueryMaker from SqlEngine.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.

Specified by:

resultTypeForSelect in interface SqlEngine

Parameters:

typeFactory - type factory

validatedRowType - row type from Calcite's validator

queryContext - query context, in case that affects the result type

resultTypeForInsert

public org.apache.calcite.rel.type.RelDataType resultTypeForInsert(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
 org.apache.calcite.rel.type.RelDataType validatedRowType,
 Map<String,Object> queryContext)

Description copied from interface: SqlEngine

SQL row type that would be emitted by the QueryMaker from SqlEngine.buildQueryMakerForInsert(org.apache.druid.sql.destination.IngestDestination, 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.

Specified by:

resultTypeForInsert in interface SqlEngine

Parameters:

typeFactory - type factory

validatedRowType - row type from Calcite's validator

queryContext - query context, in case that affects the result type

featureAvailable

public boolean featureAvailable(EngineFeature feature)

Description copied from interface: SqlEngine

Whether a feature applies to this engine or not. Most callers should use PlannerContext.featureAvailable(EngineFeature) instead, which also checks feature flags in context parameters.

Specified by:

featureAvailable in interface SqlEngine

buildQueryMakerForSelect

public QueryMaker buildQueryMakerForSelect(org.apache.calcite.rel.RelRoot relRoot,
 PlannerContext plannerContext)

Description copied from interface: SqlEngine

Create a QueryMaker for a SELECT query.

Specified by:

buildQueryMakerForSelect in interface SqlEngine

Parameters:

relRoot - planned and validated rel

plannerContext - context for this query

Returns:

an executor for the provided query

buildQueryMakerForInsert

public QueryMaker buildQueryMakerForInsert(IngestDestination destination,
 org.apache.calcite.rel.RelRoot relRoot,
 PlannerContext plannerContext)

Description copied from interface: SqlEngine

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

Specified by:

buildQueryMakerForInsert in interface SqlEngine

Parameters:

destination - destination 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

getSqlStatementFactory

public SqlStatementFactory getSqlStatementFactory()

Description copied from interface: SqlEngine

Returns a SqlStatementFactory which uses this engine to create statements.

Specified by:

getSqlStatementFactory in interface SqlEngine

cancelQuery

public void cancelQuery(PlannerContext plannerContext,
 QueryScheduler queryScheduler)

Description copied from interface: SqlEngine

Cancels a currently running query given the PlannerContext for the query.

Specified by:

cancelQuery in interface SqlEngine