org.apache.calcite.sql

Class SqlInsert

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlInsert

All Implemented Interfaces:

Cloneable

public class SqlInsert
extends SqlCall

A SqlInsert is a node of a parse tree which represents an INSERT 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
SqlInsert(SqlParserPos pos, SqlNodeList keywords, SqlNode targetTable, SqlNode source, @Nullable SqlNodeList columnList)

Method Summary

Modifier and Type	Method and Description
SqlKind	getKind() Returns the type of node this is, or SqlKind.OTHER if it's nothing special.
@Nullable SqlNode	getModifierNode(SqlInsertKeyword modifier)
List<SqlNode>	getOperandList() Returns the list of operands.
SqlOperator	getOperator()
SqlNode	getSource() Returns the source expression for the data to be inserted.
@Nullable SqlNodeList	getTargetColumnList() Returns the list of target column names, or null for all columns in the target table.
SqlNode	getTargetTable() Return the identifier for the target table of the insertion.
boolean	isUpsert() Returns whether this is an UPSERT statement.
void	setOperand(int i, @Nullable SqlNode operand) Changes the value of an operand.
void	setSource(SqlSelect source)
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

OPERATOR

public static final SqlSpecialOperator OPERATOR

Constructor Detail

SqlInsert

public SqlInsert(SqlParserPos pos,
                 SqlNodeList keywords,
                 SqlNode targetTable,
                 SqlNode source,
                 @Nullable SqlNodeList columnList)

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

isUpsert

public final boolean isUpsert()

Returns whether this is an UPSERT statement.

In SQL, this is represented using the UPSERT keyword rather than INSERT; in the abstract syntax tree, an UPSERT is indicated by the presence of a SqlInsertKeyword.UPSERT keyword.

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

getTargetTable

public SqlNode getTargetTable()

Return the identifier for the target table of the insertion.

getSource

public SqlNode getSource()

Returns the source expression for the data to be inserted.

setSource

public void setSource(SqlSelect source)

getTargetColumnList

@Pure
public @Nullable SqlNodeList getTargetColumnList()

Returns the list of target column names, or null for all columns in the target table.

getModifierNode

public final @Nullable SqlNode getModifierNode(SqlInsertKeyword modifier)

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