org.apache.calcite.sql

Class SqlDescribeTable

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlDescribeTable

All Implemented Interfaces:

Cloneable

public class SqlDescribeTable
extends SqlCall

A SqlDescribeTable is a node of a parse tree that represents a DESCRIBE TABLE statement.

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
SqlDescribeTable(SqlParserPos pos, SqlIdentifier table, @Nullable SqlIdentifier column) Creates a SqlDescribeTable.

Method Summary

Modifier and Type	Method and Description
@Nullable SqlIdentifier	getColumn()
List<SqlNode>	getOperandList() Returns the list of operands.
SqlOperator	getOperator()
SqlIdentifier	getTable()
void	setOperand(int i, @Nullable SqlNode operand) Changes the value of an operand.
void	unparse(SqlWriter writer, int leftPrec, int rightPrec) Writes a SQL representation of this node to a writer.

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

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

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

OPERATOR

public static final SqlSpecialOperator OPERATOR

Constructor Detail

SqlDescribeTable

public SqlDescribeTable(SqlParserPos pos,
                        SqlIdentifier table,
                        @Nullable SqlIdentifier column)

Creates a SqlDescribeTable.

Method Detail

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

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

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

getTable

public SqlIdentifier getTable()

getColumn

public @Nullable SqlIdentifier getColumn()