Package org.apache.druid.sql

Class SqlQueryPlus.Builder

java.lang.Object

org.apache.druid.sql.SqlQueryPlus.Builder

Enclosing class:

SqlQueryPlus

public static class SqlQueryPlus.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SqlQueryPlus.Builder	auth(AuthenticationResult authResult)
SqlQueryPlus	build()	Parses the provided sql and builds a SqlQueryPlus with SET statements folded into the context, and with the parsed SQL in SqlQueryPlus.sqlNode.
SqlQueryPlus	buildJdbc()	Builds a SqlQueryPlus with no SqlNode and with SqlQueryPlus.allowSetStatements set to false.
SqlQueryPlus.Builder	parameters(List<org.apache.calcite.avatica.remote.TypedValue> parameters)
SqlQueryPlus.Builder	queryContext(Map<String,Object> queryContext)	Sets the user-provided query context.
SqlQueryPlus.Builder	sql(String sql)
SqlQueryPlus.Builder	sqlParameters(List<SqlParameter> parameters)
SqlQueryPlus.Builder	systemDefaultContext(Map<String,Object> systemDefaultContext)	Sets the system-wide default contexts.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

sql

public SqlQueryPlus.Builder sql(String sql)

systemDefaultContext

public SqlQueryPlus.Builder systemDefaultContext(Map<String,Object> systemDefaultContext)

Sets the system-wide default contexts. This context is used to fill in missing values and doesn't go thorough authorization check.

queryContext

public SqlQueryPlus.Builder queryContext(Map<String,Object> queryContext)

Sets the user-provided query context. This context is used for authorization checks.

parameters

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

sqlParameters

public SqlQueryPlus.Builder sqlParameters(List<SqlParameter> parameters)

auth

public SqlQueryPlus.Builder auth(AuthenticationResult authResult)

build

public SqlQueryPlus build()

Parses the provided sql and builds a SqlQueryPlus with SET statements folded into the context, and with the parsed SQL in SqlQueryPlus.sqlNode.

When using this method, the SqlQueryPlus.sqlNode() must only be run through validation once. (The validator mutates the SqlNode).

buildJdbc

public SqlQueryPlus buildJdbc()

Builds a SqlQueryPlus with no SqlNode and with SqlQueryPlus.allowSetStatements set to false. This is done for JDBC becauase it can runs each SqlQueryPlus multiple times, and it needs to keep re-parsing and re-validating the query on each run.

When using this method, you must create a copy with SqlQueryPlus.freshCopy() prior to calling SqlQueryPlus.sqlNode().