Package org.apache.calcite.sql

Class SqlSetOption

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlAlter

org.apache.calcite.sql.SqlSetOption

All Implemented Interfaces:

Cloneable

public class SqlSetOption
extends SqlAlter

SQL parse tree node to represent SET and RESET statements, optionally preceded by ALTER SYSTEM or ALTER SESSION.

Syntax:

ALTER scope SET `option.name` = value;
ALTER scope RESET `option`.`name`;
ALTER scope RESET ALL;

SET `option.name` = value;
RESET `option`.`name`;
RESET ALL;

If SqlAlter.scope is null, assume a default scope. (The default scope is defined by the project using Calcite, but is typically SESSION.)

If value is null, assume RESET; if value is not null, assume SET.

Examples:

• ALTER SYSTEM SET `my`.`param1` = 1
• SET `my.param2` = 1
• SET `my.param3` = ON
• ALTER SYSTEM RESET `my`.`param1`
• RESET `my.param2`
• ALTER SESSION RESET ALL

Field Summary

Fields

Modifier and Type	Field	Description
static final SqlSpecialOperator	OPERATOR

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor	Description
SqlSetOption(SqlParserPos pos, @Nullable String scope, SqlIdentifier name, @Nullable SqlNode value)	Deprecated.
SqlSetOption(SqlParserPos pos, @Nullable String scope, SqlNode name, @Nullable SqlNode value)	Creates a node.

Method Summary

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

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

getScope, setScope

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, clone, cloneArray, equalDeep, equalDeep, equalsDeep, getParserPosition, isA, toList, toList, toSqlString, toSqlString, toSqlString, toString, unparseWithParentheses, validateExpr

Methods inherited from class java.lang.Object

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

Field Details

OPERATOR

public static final SqlSpecialOperator OPERATOR

Constructor Details

SqlSetOption

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

Creates a node.

Parameters:

pos - Parser position, must not be null.

scope - Scope (generally "SYSTEM" or "SESSION"), may be null.

name - Name of option, must not be null.

value - Value of option, as an identifier or literal, may be null. If null, assume RESET command, else assume SET command.

SqlSetOption

@Deprecated
public SqlSetOption(SqlParserPos pos,
 @Nullable String scope,
 SqlIdentifier name,
 @Nullable SqlNode value)

Deprecated.

Method Details

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 SqlCall

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()

Description copied from class: SqlCall

Returns the list of operands. The set and order of operands is call-specific.

Note: the proper type would be List<@Nullable SqlNode>, however, it would trigger too many changes to the current codebase.

Specified by:

getOperandList in class SqlCall

Returns:

the list of call operands, never null, the operands can be null

setOperand

public void setOperand(int i,
 @Nullable 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 SqlAlter

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

unparseAlterOperation

protected void unparseAlterOperation(SqlWriter writer,
 int leftPrec,
 int rightPrec)

Specified by:

unparseAlterOperation in class SqlAlter

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

Parameters:

scope - Validator

getName

@Deprecated
public SqlIdentifier getName()

Deprecated.

name

public SqlNode name()

setName

@Deprecated
public void setName(SqlIdentifier name)

Deprecated.

setName

public void setName(SqlNode name)

getValue

public @Nullable SqlNode getValue()

setValue

public void setValue(SqlNode value)