org.apache.calcite.sql

Class SqlSelect

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlSelect

All Implemented Interfaces:

Cloneable

public class SqlSelect
extends SqlCall

A SqlSelect is a node of a parse tree which represents a select statement. It warrants its own node type just because we have a lot of methods to put somewhere.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FROM_OPERAND
static int	HAVING_OPERAND
static int	WHERE_OPERAND

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor and Description
SqlSelect(SqlParserPos pos, @Nullable SqlNodeList keywordList, SqlNodeList selectList, @Nullable SqlNode from, @Nullable SqlNode where, @Nullable SqlNodeList groupBy, @Nullable SqlNode having, @Nullable SqlNodeList windowDecls, @Nullable SqlNodeList orderBy, @Nullable SqlNode offset, @Nullable SqlNode fetch, @Nullable SqlNodeList hints)

Method Summary

Modifier and Type	Method and Description
@Nullable SqlNode	getFetch()
@Nullable SqlNode	getFrom()
@Nullable SqlNodeList	getGroup()
@Nullable SqlNode	getHaving()
@Nullable SqlNodeList	getHints()
SqlKind	getKind() Returns the type of node this is, or SqlKind.OTHER if it's nothing special.
@Nullable SqlNode	getModifierNode(SqlSelectKeyword modifier)
@Nullable SqlNode	getOffset()
List<SqlNode>	getOperandList() Returns the list of operands.
SqlOperator	getOperator()
@Nullable SqlNodeList	getOrderList()
SqlNodeList	getSelectList()
@Nullable SqlNode	getWhere()
SqlNodeList	getWindowList()
boolean	hasHints()
boolean	hasOrderBy()
boolean	hasWhere()
boolean	isDistinct()
boolean	isKeywordPresent(SqlSelectKeyword targetKeyWord)
void	setFetch(@Nullable SqlNode fetch)
void	setFrom(@Nullable SqlNode from)
void	setGroupBy(@Nullable SqlNodeList groupBy)
void	setHaving(@Nullable SqlNode having)
void	setHints(@Nullable SqlNodeList hints)
void	setOffset(@Nullable SqlNode offset)
void	setOperand(int i, @Nullable SqlNode operand) Changes the value of an operand.
void	setOrderBy(@Nullable SqlNodeList orderBy)
void	setSelectList(SqlNodeList selectList)
void	setWhere(@Nullable SqlNode whereClause)
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, 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 Detail

FROM_OPERAND

public static final int FROM_OPERAND

See Also:

Constant Field Values

WHERE_OPERAND

public static final int WHERE_OPERAND

See Also:

Constant Field Values

HAVING_OPERAND

public static final int HAVING_OPERAND

See Also:

Constant Field Values

Constructor Detail

SqlSelect

public SqlSelect(SqlParserPos pos,
                 @Nullable SqlNodeList keywordList,
                 SqlNodeList selectList,
                 @Nullable SqlNode from,
                 @Nullable SqlNode where,
                 @Nullable SqlNodeList groupBy,
                 @Nullable SqlNode having,
                 @Nullable SqlNodeList windowDecls,
                 @Nullable SqlNodeList orderBy,
                 @Nullable SqlNode offset,
                 @Nullable SqlNode fetch,
                 @Nullable SqlNodeList hints)

Method Detail

getOperator

public SqlOperator getOperator()

Specified by:

getOperator in class SqlCall

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

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

isDistinct

public final boolean isDistinct()

getModifierNode

public final @Nullable SqlNode getModifierNode(SqlSelectKeyword modifier)

getFrom

@Pure
public final @Nullable SqlNode getFrom()

setFrom

public void setFrom(@Nullable SqlNode from)

getGroup

@Pure
public final @Nullable SqlNodeList getGroup()

setGroupBy

public void setGroupBy(@Nullable SqlNodeList groupBy)

getHaving

@Pure
public final @Nullable SqlNode getHaving()

setHaving

public void setHaving(@Nullable SqlNode having)

getSelectList

@Pure
public final SqlNodeList getSelectList()

setSelectList

public void setSelectList(SqlNodeList selectList)

getWhere

@Pure
public final @Nullable SqlNode getWhere()

setWhere

public void setWhere(@Nullable SqlNode whereClause)

getWindowList

public final SqlNodeList getWindowList()

getOrderList

@Pure
public final @Nullable SqlNodeList getOrderList()

setOrderBy

public void setOrderBy(@Nullable SqlNodeList orderBy)

getOffset

@Pure
public final @Nullable SqlNode getOffset()

setOffset

public void setOffset(@Nullable SqlNode offset)

getFetch

@Pure
public final @Nullable SqlNode getFetch()

setFetch

public void setFetch(@Nullable SqlNode fetch)

setHints

public void setHints(@Nullable SqlNodeList hints)

getHints

@Pure
public @Nullable SqlNodeList getHints()

hasHints

@EnsuresNonNullIf(expression="hints",
                  result=true)
public boolean hasHints()

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

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

hasOrderBy

public boolean hasOrderBy()

hasWhere

public boolean hasWhere()

isKeywordPresent

public boolean isKeywordPresent(SqlSelectKeyword targetKeyWord)