Package org.apache.druid.sql.http

Class SqlResource

java.lang.Object

org.apache.druid.sql.http.SqlResource

public class SqlResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH
static final org.apache.druid.sql.http.SqlResource.SqlResourceQueryMetricCounter	QUERY_METRIC_COUNTER
static final String	SQL_HEADER_RESPONSE_HEADER
static final String	SQL_HEADER_VALUE
static final String	SQL_QUERY_ID_RESPONSE_HEADER

Constructor Summary

Constructors

Constructor	Description
SqlResource(AuthorizerMapper authorizerMapper, SqlLifecycleManager sqlLifecycleManager, SqlEngineRegistry sqlEngineRegistry, SqlResourceQueryResultPusherFactory resultPusherFactory, QueryConfigProvider queryConfigProvider, ServerConfig serverConfig)

Method Summary

Modifier and Type	Method	Description
AuthorizationResult	authorizeCancellation(javax.servlet.http.HttpServletRequest req, List<SqlLifecycleManager.Cancelable> cancelables)	Authorize a query cancellation operation.
javax.ws.rs.core.Response	cancelQuery(String sqlQueryId, javax.servlet.http.HttpServletRequest req)
javax.ws.rs.core.Response	doGetQueryReport(String sqlQueryId, String selfOnly, javax.servlet.http.HttpServletRequest request)	API to get query reports, for all engines that support such reports.
javax.ws.rs.core.Response	doGetRunningQueries(String selfOnly, String includeComplete, javax.servlet.http.HttpServletRequest request)	API to list all running queries, for all engines that supports such listings.
javax.ws.rs.core.Response	doPost(javax.servlet.http.HttpServletRequest req, com.sun.jersey.api.core.HttpContext httpContext)
javax.ws.rs.core.Response	doPost(SqlQuery sqlQuery, javax.servlet.http.HttpServletRequest req)	This method is defined as public so that tests can access it
javax.ws.rs.core.Response	getSupportedEngines(javax.servlet.http.HttpServletRequest request)
static javax.ws.rs.core.Response	handleExceptionBeforeStatementCreated(Exception e, QueryContext queryContext, ErrorResponseTransformStrategy strategy)	Generates a response for a DruidException that occurs prior to the HttpStatement being created.
static SqlQueryPlus	makeSqlQueryPlus(SqlQuery sqlQuery, javax.servlet.http.HttpServletRequest req, Map<String,Object> defaultQueryConfig)	Create a SqlQueryPlus, which involves parsing the query from SqlQuery.getQuery() and extracing any SET parameters into the query context.

Methods inherited from class java.lang.Object

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

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

SQL_QUERY_ID_RESPONSE_HEADER

public static final String SQL_QUERY_ID_RESPONSE_HEADER

See Also:

• Constant Field Values

SQL_HEADER_RESPONSE_HEADER

public static final String SQL_HEADER_RESPONSE_HEADER

See Also:

• Constant Field Values

SQL_HEADER_VALUE

public static final String SQL_HEADER_VALUE

See Also:

• Constant Field Values

QUERY_METRIC_COUNTER

public static final org.apache.druid.sql.http.SqlResource.SqlResourceQueryMetricCounter QUERY_METRIC_COUNTER

Constructor Details

SqlResource

@Inject
public SqlResource(AuthorizerMapper authorizerMapper,
 SqlLifecycleManager sqlLifecycleManager,
 SqlEngineRegistry sqlEngineRegistry,
 SqlResourceQueryResultPusherFactory resultPusherFactory,
 QueryConfigProvider queryConfigProvider,
 ServerConfig serverConfig)

Method Details

getSupportedEngines

public javax.ws.rs.core.Response getSupportedEngines(@Context
 javax.servlet.http.HttpServletRequest request)

doPost

@Nullable
public javax.ws.rs.core.Response doPost(@Context
 javax.servlet.http.HttpServletRequest req,
 @Context
 com.sun.jersey.api.core.HttpContext httpContext)

doGetRunningQueries

public javax.ws.rs.core.Response doGetRunningQueries(String selfOnly,
 String includeComplete,
 @Context
 javax.servlet.http.HttpServletRequest request)

API to list all running queries, for all engines that supports such listings.

Parameters:

selfOnly - if present, return queries running on this server only. If absent, return queries running on all servers.

includeComplete - if present, include completed queries in the response. The number of completed queries returned is determined by engine-specific retention settings.

request - http request.

doGetQueryReport

public javax.ws.rs.core.Response doGetQueryReport(String sqlQueryId,
 String selfOnly,
 @Context
 javax.servlet.http.HttpServletRequest request)

API to get query reports, for all engines that support such reports.

Parameters:

sqlQueryId - SQL query ID

selfOnly - if true, check reports from this server only. If false, check reports on all servers.

request - http request.

doPost

public javax.ws.rs.core.Response doPost(SqlQuery sqlQuery,
 javax.servlet.http.HttpServletRequest req)

This method is defined as public so that tests can access it

cancelQuery

public javax.ws.rs.core.Response cancelQuery(String sqlQueryId,
 @Context
 javax.servlet.http.HttpServletRequest req)

authorizeCancellation

public AuthorizationResult authorizeCancellation(javax.servlet.http.HttpServletRequest req,
 List<SqlLifecycleManager.Cancelable> cancelables)

Authorize a query cancellation operation.

Considers only datasource and table resources; not context key resources when checking permissions. This means that a user's permission to cancel a query depends on the datasource, not the context variables used in the query.

makeSqlQueryPlus

public static SqlQueryPlus makeSqlQueryPlus(SqlQuery sqlQuery,
 javax.servlet.http.HttpServletRequest req,
 Map<String,Object> defaultQueryConfig)

Create a SqlQueryPlus, which involves parsing the query from SqlQuery.getQuery() and extracing any SET parameters into the query context.

handleExceptionBeforeStatementCreated

public static javax.ws.rs.core.Response handleExceptionBeforeStatementCreated(Exception e,
 QueryContext queryContext,
 ErrorResponseTransformStrategy strategy)

Generates a response for a DruidException that occurs prior to the HttpStatement being created.