gudusoft.gsqlparser.nodes

Class TOnConflictClause

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.nodes.TOnConflictClause

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>

public class TOnConflictClause
extends TParseTreeNode

Represents a PostgreSQL INSERT ... ON CONFLICT clause (UPSERT).

PostgreSQL syntax:

 INSERT INTO table_name ...
 ON CONFLICT [ conflict_target ] conflict_action

 conflict_target:
   ( { index_column_name | ( index_expression ) } [, ...] ) [ WHERE index_predicate ]
   | ON CONSTRAINT constraint_name

 conflict_action:
   DO NOTHING
   | DO UPDATE SET { column_name = expression } [, ...] [ WHERE condition ]
 

See Also:

TInsertSqlStatement.getOnConflictClause()

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors

Constructor and Description
TOnConflictClause()

Method Summary

Modifier and Type	Method and Description
void	acceptChildren(TParseTreeVisitor v) Accept a visitor to iterate this class and sub-nodes of this class
void	doParse(TCustomSqlStatement psql, ESqlClause clauseType) Parses the ON CONFLICT clause within the context of the parent statement.
EOnConflictActionType	getActionType() Returns the conflict action type: DO NOTHING or DO UPDATE.
TObjectName	getConstraintName() Returns the constraint name when ON CONSTRAINT syntax is used.
TOrderByItemList	getIndexColumns() Returns the list of index column names or expressions that form the conflict target.
TWhereClause	getIndexWhereClause() Returns the WHERE clause for the partial unique index predicate on the conflict target.
TResultColumnList	getUpdateSetClause() Returns the SET clause assignments for the DO UPDATE action.
TWhereClause	getUpdateWhereClause() Returns the WHERE clause for the DO UPDATE action.
void	setActionType(EOnConflictActionType actionType)
void	setConflictTarget(TDummy dummy) Sets the conflict target from a TDummy node produced by the grammar.
void	setConstraintName(TObjectName constraintName)
void	setIndexColumns(TOrderByItemList indexColumns)
void	setIndexWhereClause(TWhereClause indexWhereClause)
void	setUpdateSetClause(TResultColumnList updateSetClause)
void	setUpdateWhereClause(TWhereClause updateWhereClause)

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

accept, addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, getPlainText, getStartToken, getTokenCount, hasNext, init, init, init, init, init, init, init, init, init, init, insertAfterAToken, insertNewNodeBeforeMe, isChanged, isTokensInChain, next, refreshAllNodesTokenCount, remove, removeAllMyTokensFromTokenList, removeTokens, removeTokensBetweenNodes, removeTokensBetweenToken, replaceWithNewNode, resetIterator, setAnchorNode, setChanged, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setEndToken, setEndTokenDirectly, setEvaluateDatatype, setEvalValue, setGsqlparser, setIncludingComment, setLocation, setNewSubNode, setNodeStatus, setNodeType, setParent, setPlainText, setStartToken, setStartToken, setStartToken, setStartToken, setStartTokenDirectly, setString, setString2, subNodeInNode, toScript, toString, toString2

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining

Constructor Detail

TOnConflictClause

public TOnConflictClause()

Method Detail

getActionType

public EOnConflictActionType getActionType()

Returns the conflict action type: DO NOTHING or DO UPDATE.

Returns:

the action type

setActionType

public void setActionType(EOnConflictActionType actionType)

getIndexColumns

public TOrderByItemList getIndexColumns()

Returns the list of index column names or expressions that form the conflict target.

Returns:

the index column list, or null if ON CONSTRAINT or no target specified

setIndexColumns

public void setIndexColumns(TOrderByItemList indexColumns)

getConstraintName

public TObjectName getConstraintName()

Returns the constraint name when ON CONSTRAINT syntax is used.

Returns:

the constraint name, or null

setConstraintName

public void setConstraintName(TObjectName constraintName)

getIndexWhereClause

public TWhereClause getIndexWhereClause()

Returns the WHERE clause for the partial unique index predicate on the conflict target.

Returns:

the index WHERE clause, or null

setIndexWhereClause

public void setIndexWhereClause(TWhereClause indexWhereClause)

getUpdateSetClause

public TResultColumnList getUpdateSetClause()

Returns the SET clause assignments for the DO UPDATE action.

Returns:

the SET clause result column list, or null if DO NOTHING

setUpdateSetClause

public void setUpdateSetClause(TResultColumnList updateSetClause)

getUpdateWhereClause

public TWhereClause getUpdateWhereClause()

Returns the WHERE clause for the DO UPDATE action.

Returns:

the update WHERE clause, or null

setUpdateWhereClause

public void setUpdateWhereClause(TWhereClause updateWhereClause)

setConflictTarget

public void setConflictTarget(TDummy dummy)

Sets the conflict target from a TDummy node produced by the grammar. The TDummy carries: list1 = index columns (TOrderByItemList), node1 = index WHERE clause (TWhereClause), node2 = constraint name (TObjectName).

doParse

public void doParse(TCustomSqlStatement psql,
                    ESqlClause clauseType)

Parses the ON CONFLICT clause within the context of the parent statement.

Overrides:

doParse in class TParseTreeNode

Parameters:

psql - SQL statement this node belongs to

clauseType - SQL clause this node belongs to

acceptChildren

public void acceptChildren(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor to iterate this class and sub-nodes of this class

Specified by:

acceptChildren in interface Visitable

Overrides:

acceptChildren in class TParseTreeNode

Parameters:

v - visitor is a descendant class of TParseTreeVisitor