org.apache.calcite.sql

Class SqlSetOption

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlSetOption

All Implemented Interfaces:

Cloneable

public class SqlSetOption
extends SqlCall

SQL parse tree node to represent ALTER scope SET option = value statement.

Example:

ALTER SYSTEM SET myParam = 1

Field Summary

Fields

Modifier and Type	Field and Description
static SqlSpecialOperator	OPERATOR

Fields inherited from class org.apache.calcite.sql.SqlNode

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor and Description
SqlSetOption(SqlParserPos pos, String scope, String name, SqlNode value) Creates a node.

Method Summary

Methods

Modifier and Type	Method and Description
SqlKind	getKind() Returns the type of node this is, or SqlKind.OTHER if it's nothing special.
String	getName()
List<SqlNode>	getOperandList()
SqlOperator	getOperator()
String	getScope()
SqlNode	getValue()
void	setName(String name)
void	setOperand(int i, SqlNode operand) Changes the value of an operand.
void	setScope(String scope)
void	setValue(SqlNode value)
void	unparse(SqlWriter writer, int leftPrec, int rightPrec) Writes a SQL representation of this node to a writer.
void	validate(SqlValidator validator, SqlValidatorScope scope) Validates this call.

Methods inherited from class org.apache.calcite.sql.SqlCall

accept, clone, equalsDeep, findValidOptions, getCallSignature, getFunctionQuantifier, getMonotonicity, isCountStar, isExpanded, operand, operandCount

Methods inherited from class org.apache.calcite.sql.SqlNode

clone, cloneArray, equalDeep, equalDeep, getParserPosition, isA, toSqlString, toSqlString, toString, validateExpr

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR

public static final SqlSpecialOperator OPERATOR

Constructor Detail

SqlSetOption

public SqlSetOption(SqlParserPos pos,
            String scope,
            String name,
            SqlNode value)

Creates a node.

Parameters:

pos - Parser position, must not be null.

scope - Scope (generally "SYSTEM" or "SESSION")

name - Name of option

value - Value of option, as an identifier or literal.

Method Detail

getKind

public SqlKind getKind()

Description copied from class: SqlNode

Returns the type of node this is, or SqlKind.OTHER if it's nothing special.

Overrides:

getKind in class SqlNode

Returns:

a SqlKind value, never null

See Also:

SqlNode.isA(java.util.Set<org.apache.calcite.sql.SqlKind>)

getOperator

public SqlOperator getOperator()

Specified by:

getOperator in class SqlCall

getOperandList

public List<SqlNode> getOperandList()

Specified by:

getOperandList in class SqlCall

setOperand

public void setOperand(int i,
              SqlNode operand)

Description copied from class: SqlCall

Changes the value of an operand. Allows some rewrite by SqlValidator; use sparingly.

Overrides:

setOperand in class SqlCall

Parameters:

i - Operand index

operand - Operand value

unparse

public void unparse(SqlWriter writer,
           int leftPrec,
           int rightPrec)

Description copied from class: SqlNode

Writes a SQL representation of this node to a writer.

The leftPrec and rightPrec parameters give us enough context to decide whether we need to enclose the expression in parentheses. For example, we need parentheses around "2 + 3" if preceded by "5 *". This is because the precedence of the "*" operator is greater than the precedence of the "+" operator.

The algorithm handles left- and right-associative operators by giving them slightly different left- and right-precedence.

If SqlWriter.isAlwaysUseParentheses() is true, we use parentheses even when they are not required by the precedence rules.

For the details of this algorithm, see SqlCall.unparse(org.apache.calcite.sql.SqlWriter, int, int).

Overrides:

unparse in class SqlCall

Parameters:

writer - Target writer

leftPrec - The precedence of the SqlNode immediately preceding this node in a depth-first scan of the parse tree

rightPrec - The precedence of the SqlNode immediately

validate

public void validate(SqlValidator validator,
            SqlValidatorScope scope)

Description copied from class: SqlCall

Validates this call.

The default implementation delegates the validation to the operator's SqlOperator.validateCall(org.apache.calcite.sql.SqlCall, org.apache.calcite.sql.validate.SqlValidator, org.apache.calcite.sql.validate.SqlValidatorScope, org.apache.calcite.sql.validate.SqlValidatorScope). Derived classes may override (as do, for example SqlSelect and SqlUpdate).

Overrides:

validate in class SqlCall

scope - Validator

getName

public String getName()

setName

public void setName(String name)

getScope

public String getScope()

setScope

public void setScope(String scope)

getValue

public SqlNode getValue()

setValue

public void setValue(SqlNode value)