org.apache.druid.sql

Class AbstractStatement

java.lang.Object

org.apache.druid.sql.AbstractStatement

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DirectStatement, PreparedStatement

public abstract class AbstractStatement
extends Object
implements Closeable

Represents a SQL statement either for preparation or execution. A statement is given by a lifecycle context and the statement to execute. See derived classes for actions. Closing the statement emits logs and metrics for the statement.

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<ResourceAction>	cancellationResourceActions Resource actions used with authorizing a cancellation request.
protected Set<ResourceAction>	fullResourceActions Full resource actions authorized as part of this request.
protected PlannerContext	plannerContext
protected SqlQueryPlus	queryPlus
protected SqlExecutionReporter	reporter
protected SqlToolbox	sqlToolbox

Constructor Summary

Constructors

Constructor and Description
AbstractStatement(SqlToolbox sqlToolbox, SqlQueryPlus queryPlus, String remoteAddress)

Method Summary

Modifier and Type	Method and Description
Set<ResourceAction>	allResources()
protected void	authorize(DruidPlanner planner, Function<Set<ResourceAction>,Access> authorizer) Authorize the query using the authorizer provided, and an option to authorize context variables as well as query resources.
protected Function<Set<ResourceAction>,Access>	authorizer() Resource authorizer based on the authentication result provided earlier.
void	close() Releases resources and emits logs and metrics as defined the associated reporter.
void	closeQuietly() Closes the statement without reporting metrics.
void	closeWithError(Throwable e) Convenience method to close the statement and report an error associated with the statement.
SqlQueryPlus	query()
SqlExecutionReporter	reporter()
Set<ResourceAction>	resources() Return the datasource and table resources for this statement.
String	sqlQueryId()
protected void	validate(DruidPlanner planner) Validate SQL query and authorize against any datasources or views which will take part in the query.

Methods inherited from class java.lang.Object

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

Field Detail

sqlToolbox

protected final SqlToolbox sqlToolbox

queryPlus

protected final SqlQueryPlus queryPlus

reporter

protected final SqlExecutionReporter reporter

plannerContext

protected PlannerContext plannerContext

cancellationResourceActions

protected Set<ResourceAction> cancellationResourceActions

Resource actions used with authorizing a cancellation request. These actions include only the data-level actions (i.e. the datasource.)

fullResourceActions

protected Set<ResourceAction> fullResourceActions

Full resource actions authorized as part of this request. Used when logging resource actions. Includes the query context, if query context authorization is enabled.

Constructor Detail

AbstractStatement

public AbstractStatement(SqlToolbox sqlToolbox,
                         SqlQueryPlus queryPlus,
                         String remoteAddress)

Method Detail

sqlQueryId

public String sqlQueryId()

validate

protected void validate(DruidPlanner planner)

Validate SQL query and authorize against any datasources or views which will take part in the query. Must be called by the API methods, not directly.

authorize

protected void authorize(DruidPlanner planner,
                         Function<Set<ResourceAction>,Access> authorizer)

Authorize the query using the authorizer provided, and an option to authorize context variables as well as query resources.

authorizer

protected Function<Set<ResourceAction>,Access> authorizer()

Resource authorizer based on the authentication result provided earlier.

resources

public Set<ResourceAction> resources()

Return the datasource and table resources for this statement.

allResources

public Set<ResourceAction> allResources()

query

public SqlQueryPlus query()

reporter

public SqlExecutionReporter reporter()

close

public void close()

Releases resources and emits logs and metrics as defined the associated reporter.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

closeQuietly

public void closeQuietly()

Closes the statement without reporting metrics.

closeWithError

public void closeWithError(Throwable e)

Convenience method to close the statement and report an error associated with the statement. Same as calling:stmt.reporter().failed(e); stmt.close();