Package org.apache.druid.sql

Class SqlQueryPlus

java.lang.Object

org.apache.druid.sql.SqlQueryPlus

public class SqlQueryPlus
extends Object

Captures the inputs to a SQL execution request: the statement (as a string), the parsed statement, the context, parameters, and the authorization result. The request can evolve: the context and parameters can be filled in later as needed.

SQL requests come from a variety of sources in a variety of formats. Use the SqlQueryPlus.Builder class to create an instance from the information available at each point in the code.

Each instance of SqlQueryPlus can only be used once, because sqlNode is a mutable data structure, modified during CalcitePlanner.validate(org.apache.calcite.sql.SqlNode). If you need to use one again, call freshCopy() to create a fresh copy with a new SqlNode.

The query context has a complex lifecycle. The copy here is immutable: it is the set of values which the user requested. Planning will add (and sometimes remove) values: that work should be done on a copy of the context so that we have a clean record of the user's original requested values. This original record is required to perform security on the set of user-provided context keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SqlQueryPlus.Builder

Method Summary

Modifier and Type	Method	Description
Set<String>	authContextKeys()
AuthenticationResult	authResult()
static SqlQueryPlus.Builder	builder()
static SqlQueryPlus.Builder	builder(String sql)
Map<String,Object>	context()
SqlQueryPlus	freshCopy()	Returns a copy of this instance where everything is shared, except the sqlNode, which is re-parsed from the SQL statement.
List<org.apache.calcite.avatica.remote.TypedValue>	parameters()
String	sql()
org.apache.calcite.sql.SqlNode	sqlNode()
List<ClientSqlParameter>	sqlParameters()	Convert parameters list to serde friendly SqlParameter
String	toString()
SqlQueryPlus	withContext(Map<String,Object> defaultContext, Map<String,Object> userProvidedContext)
SqlQueryPlus	withParameters(List<org.apache.calcite.avatica.remote.TypedValue> parameters)

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SqlQueryPlus.Builder builder()

builder

public static SqlQueryPlus.Builder builder(String sql)

sql

public String sql()

sqlNode

public org.apache.calcite.sql.SqlNode sqlNode()

context

public Map<String,Object> context()

authContextKeys

public Set<String> authContextKeys()

parameters

public List<org.apache.calcite.avatica.remote.TypedValue> parameters()

sqlParameters

@Nullable
public List<ClientSqlParameter> sqlParameters()

Convert parameters list to serde friendly SqlParameter

authResult

public AuthenticationResult authResult()

withContext

public SqlQueryPlus withContext(Map<String,Object> defaultContext,
 Map<String,Object> userProvidedContext)

withParameters

public SqlQueryPlus withParameters(List<org.apache.calcite.avatica.remote.TypedValue> parameters)

freshCopy

public SqlQueryPlus freshCopy()

Returns a copy of this instance where everything is shared, except the sqlNode, which is re-parsed from the SQL statement.

toString

public String toString()

Overrides:

toString in class Object