org.apache.druid.sql

Class SqlLifecycle

java.lang.Object

org.apache.druid.sql.SqlLifecycle

public class SqlLifecycle
extends Object

Similar to QueryLifecycle, this class manages the lifecycle of a SQL query. It ensures that a SQL query goes through the following stages, in the proper order:

1. Initialization (initialize(String, Map))
2. Planning (plan(HttpServletRequest) or plan(AuthenticationResult))
3. Authorization (authorize())
4. Execution (execute())
5. Logging (emitLogsAndMetrics(Throwable, String, long))

Unlike QueryLifecycle, this class is designed to be thread safe so that it can be used in multi-threaded scenario (JDBC) without external synchronization.

Constructor Summary

Constructors

Constructor and Description
SqlLifecycle(PlannerFactory plannerFactory, ServiceEmitter emitter, RequestLogger requestLogger, long startMs, long startNs)

Method Summary

Modifier and Type	Method and Description
Access	authorize()
void	emitLogsAndMetrics(Throwable e, String remoteAddress, long bytesWritten) Emit logs and metrics for this query.
Sequence<Object[]>	execute()
String	initialize(String sql, Map<String,Object> queryContext)
PlannerContext	plan(AuthenticationResult authenticationResult)
PlannerContext	plan(javax.servlet.http.HttpServletRequest req)
PlannerContext	planAndAuthorize(AuthenticationResult authenticationResult)
PlannerContext	planAndAuthorize(javax.servlet.http.HttpServletRequest req)
org.apache.calcite.rel.type.RelDataType	rowType()
Sequence<Object[]>	runSimple(String sql, Map<String,Object> queryContext, AuthenticationResult authenticationResult)

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlLifecycle

public SqlLifecycle(PlannerFactory plannerFactory,
                    ServiceEmitter emitter,
                    RequestLogger requestLogger,
                    long startMs,
                    long startNs)

Method Detail

initialize

public String initialize(String sql,
                         Map<String,Object> queryContext)

plan

public PlannerContext plan(AuthenticationResult authenticationResult)
                    throws org.apache.calcite.tools.ValidationException,
                           org.apache.calcite.tools.RelConversionException,
                           org.apache.calcite.sql.parser.SqlParseException

Throws:

org.apache.calcite.tools.ValidationException

org.apache.calcite.tools.RelConversionException

org.apache.calcite.sql.parser.SqlParseException

plan

public PlannerContext plan(javax.servlet.http.HttpServletRequest req)
                    throws org.apache.calcite.sql.parser.SqlParseException,
                           org.apache.calcite.tools.RelConversionException,
                           org.apache.calcite.tools.ValidationException

Throws:

org.apache.calcite.sql.parser.SqlParseException

org.apache.calcite.tools.RelConversionException

org.apache.calcite.tools.ValidationException

rowType

public org.apache.calcite.rel.type.RelDataType rowType()

authorize

public Access authorize()

planAndAuthorize

public PlannerContext planAndAuthorize(AuthenticationResult authenticationResult)
                                throws org.apache.calcite.sql.parser.SqlParseException,
                                       org.apache.calcite.tools.RelConversionException,
                                       org.apache.calcite.tools.ValidationException

Throws:

org.apache.calcite.sql.parser.SqlParseException

org.apache.calcite.tools.RelConversionException

org.apache.calcite.tools.ValidationException

planAndAuthorize

public PlannerContext planAndAuthorize(javax.servlet.http.HttpServletRequest req)
                                throws org.apache.calcite.sql.parser.SqlParseException,
                                       org.apache.calcite.tools.RelConversionException,
                                       org.apache.calcite.tools.ValidationException

Throws:

org.apache.calcite.sql.parser.SqlParseException

org.apache.calcite.tools.RelConversionException

org.apache.calcite.tools.ValidationException

execute

public Sequence<Object[]> execute()

runSimple

public Sequence<Object[]> runSimple(String sql,
                                    Map<String,Object> queryContext,
                                    AuthenticationResult authenticationResult)
                             throws org.apache.calcite.tools.ValidationException,
                                    org.apache.calcite.tools.RelConversionException,
                                    org.apache.calcite.sql.parser.SqlParseException

Throws:

org.apache.calcite.tools.ValidationException

org.apache.calcite.tools.RelConversionException

org.apache.calcite.sql.parser.SqlParseException

emitLogsAndMetrics

public void emitLogsAndMetrics(@Nullable
                               Throwable e,
                               @Nullable
                               String remoteAddress,
                               long bytesWritten)

Emit logs and metrics for this query.

Parameters:

e - exception that occurred while processing this query

remoteAddress - remote address, for logging; or null if unknown

bytesWritten - number of bytes written; will become a query/bytes metric if >= 0