gudusoft.gsqlparser.stmt

Class TInsertSqlStatement

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TInsertSqlStatement

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TInsertSqlStatement
extends TCustomSqlStatement

SQL insert statement.

TCustomSqlStatement.getTargetTable() returns the table or view that receive the data.
getColumnList() returns the list of columns in target table if specified.
Usually, the data comes from a value clause, you can get those values from getValues().
Always checking getInsertSource() before fetch the data source which may various from value clause to subquery and other forms. Below are some data source types:

• EInsertSource.values -> getValues()
• EInsertSource.subquery -> getSubQuery()

Examples:

 INSERT INTO Production.UnitMeasure (Name, UnitMeasureCode,ModifiedDate)
 VALUES (N'Square Yards', N'Y2', GETDATE());
 

Table name: Production.UnitMeasure. Fetched from TCustomSqlStatement.getTargetTable() or the first element of TCustomSqlStatement.tables
column list: (Name, UnitMeasureCode,ModifiedDate). Fetch from getColumnList()
value list: (N'Square Yards', N'Y2', GETDATE()). Fetch from getValues()

 INSERT INTO dbo.EmployeeSales
 SELECT 'SELECT', sp.BusinessEntityID, c.LastName, sp.SalesYTD
 FROM Sales.SalesPerson AS sp
 INNER JOIN Person.Person AS c
 ON sp.BusinessEntityID = c.BusinessEntityID
 WHERE sp.BusinessEntityID LIKE '2%'
 ORDER BY sp.BusinessEntityID, c.LastName;
 

select query in above insert statement can be fetched from getSubQuery()

See Also:

TCustomSqlStatement.cteList, TCustomSqlStatement.targetTable, TCustomSqlStatement.outputClause, TCustomSqlStatement.returningClause

Nested Class Summary

Nested classes/interfaces inherited from class gudusoft.gsqlparser.TCustomSqlStatement

TCustomSqlStatement.SqlNormalizationProfile

Field Summary

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

dummytag, fromClause, fromSourceJoin, fromSourceTable, isctequery, isparsed, joins, parser, plsqlparser, relationAttributes, rootNode, semicolonended, sourcetokenlist, sqlstatementtype, stmtScope, tables

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Constructor Summary

Constructors

Constructor and Description
TInsertSqlStatement(EDbVendor dbvendor)

Method Summary

Modifier and Type	Method and Description
void	accept(TParseTreeVisitor v) Accept a visitor
void	acceptChildren(TParseTreeVisitor v) Accept a visitor to iterate this class and sub-nodes of this class
int	doParseStatement(TCustomSqlStatement psql)
TObjectNameList	getColumnList() columns of the target table.
TObjectName	getDirectoryName() Hive directory name
TPTNodeList<TInsertIntoValue>	getElseIntoValues() Oracle, values in else clause
TErrorLoggingClause	getErrorLoggingClause() Oracle error logging clause
TMssqlExecute	getExecuteStmt() SQL Server, execute statement used in the insert statement.
String	getFileFormat()
String	getFileOptions()
TFunctionCall	getFunctionCall() value clause valid when getInsertSource() is EInsertSource.values_function.
EHiveInsertType	getHiveInsertType() Hive insert type
TSourceToken	getIgnore() IGNORE keyword used in the insert statement.
TPTNodeList<TInsertCondition>	getInsertConditions() Oracle insert condition
TPTNodeList<TInsertIntoValue>	getInsertIntoValues() Oracle insert into values used after insert all/first clause
TObjectName	getInsertRowAlias() Get MySQL 8.0.20+ row alias for INSERT ...
TObjectNameList	getInsertRowAliasColumnList() Get MySQL 8.0.20+ optional column aliases for the row alias.
EInsertSource	getInsertSource() Type of the source from where the data is coming for this insert statement.
TSourceToken	getInsertToken() INSERT keyword
ArrayList<TInsertSqlStatement>	getMultiInsertStatements() Hive, from table insert..., insert ...
TOnConflictClause	getOnConflictClause() PostgreSQL ON CONFLICT clause (UPSERT).
TResultColumnList	getOnDuplicateKeyUpdate() MySQL on duplicate key update column list.
TSourceToken	getPriority_delayed() DELAY, LOW_PRIORITY, HIGH_PRIORITY keyword used in insert statement.
TObjectName	getRecordName() Oracle PLSQL record name in values clause, getInsertSource() returns EInsertSource.values_oracle_record
TResultColumnList	getSetColumnValues() set column value clauses in MySQL insert statement.
TObjectName	getSourceValueTable()
TSelectSqlStatement	getSubQuery() value clause valid when getInsertSource() is EInsertSource.subquery.
TMultiTargetList	getValues() value clause, valid when getInsertSource() is EInsertSource.values.
int	getValueType() Deprecated. As of v1.6.4.9, use getInsertSource() instead.
boolean	isInsertAll() Oracle insert all
boolean	isInsertFirst() Oracle insert first
boolean	isMultiTableInsert() Whether this is a multi-table insert, INSERT ALL or INSERT FIRST: the VALUES of its INTO clauses read the select list of its subquery.
void	setColumnList(TObjectNameList columnList)
void	setDirectoryName(TObjectName directoryName)
void	setErrorLoggingClause(TErrorLoggingClause errorLoggingClause)
void	setExecuteStmt(TMssqlExecute executeStmt)
void	setFunctionCall(TFunctionCall functionCall)
void	setHiveInsertType(EHiveInsertType hiveInsertType)
void	setInsertAll(boolean insertAll)
void	setInsertConditions(TPTNodeList<TInsertCondition> insertConditions)
void	setInsertFirst(boolean insertFirst)
void	setInsertIntoValues(TPTNodeList<TInsertIntoValue> insertIntoValues)
void	setInsertSource(EInsertSource insertSource)
void	setInsertToken(TSourceToken insertToken)
void	setOnDuplicateKeyUpdate(TResultColumnList onDuplicateKeyUpdate)
void	setRecordName(TObjectName recordName)
void	setSetColumnValues(TResultColumnList setColumnValues)
void	setSubQuery(TSelectSqlStatement subQuery)
void	setValues(TMultiTargetList values)
void	setValueType(int valueType)

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

addToTables, addWhereClause, analyzeFromTable, analyzeFromTable, analyzeJoin, analyzeTablename, analyzeTableOrJoin, asCanonical, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, computeSqlHash, dochecksyntax, findTable, fireOnMetaDatabaseTableColumn, getAncestorStmt, getAttributes, getColumnsInTable, getColumnsInTable, getCteIncludeThisStmt, getCteList, getDaxFunctionStack, getEndlabelName, getErrorCount, getErrormessage, getExpandedResultColumns, getFirstPhysicalTable, getFrameStack, getFromClause, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, getLabelName, getOrphanColumns, getOutputClause, getParentObjectName, getParentStmt, getQueryId, getRelationName, getRelations, getResultColumnList, getReturningClause, getSqlEnv, getSqlHash, getSqlHash, getStatements, getStmtScope, getSymbolTable, getSyntaxErrors, getSyntaxHints, getTables, getTargetTable, getTokenList, getTopClause, getTopStatement, getUsingVariableList, getVariableStack, getWhereClause, isathenaplsql, isBigQueryplsql, isdatabricksplsql, isGaussDBStoredProcedure, isgreeplumplsql, isMySQLDialect, isMySQLDialect, isnzplsql, isoracleplsql, isOraclePseudoColumnReference, isOracleSequencePseudoColumnReference, ispgplsql, isprestoplsql, issnowflakeplsql, isTableACTE, isverticaplsql, linkColumnReferenceToTable, linkColumnToTable, linkToFirstTable, locateVariableOrParameter, locateVariableOrParameter, OracleStatementCanBeSeparatedByBeginEndPair, parseerrormessagehandle, parsestatement, parsestatement, searchCTEList, searchDaxVariableInStack, searchFunctionInSQLEnv, setAlreadyAddToParent, setCteIncludeThisStmt, setCteList, setEndlabelName, setFrameStack, setFromClause, setLabelName, setOutputClause, setParentStmt, setParentStmtToNull, setQueryId, setResultColumnList, setReturningClause, setSqlHash, setStmtScope, setTargetTable, setTopClause, setUsingVariableList, setVariableStack, setWhereClause, size, toNormalizedSql, toScript, unbindCteTarget, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, commentBlockAfter, commentBlockEndAfter, doAppendNewNode, doParse, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCommentBeforeNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, 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, 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

TInsertSqlStatement

public TInsertSqlStatement(EDbVendor dbvendor)

Method Detail

getMultiInsertStatements

public ArrayList<TInsertSqlStatement> getMultiInsertStatements()

Hive, from table insert..., insert ...

Returns:

getFileFormat

public String getFileFormat()

getFileOptions

public String getFileOptions()

getSourceValueTable

public TObjectName getSourceValueTable()

setInsertAll

public void setInsertAll(boolean insertAll)

setInsertFirst

public void setInsertFirst(boolean insertFirst)

isInsertAll

public boolean isInsertAll()

Oracle insert all

Returns:

Oracle insert all

isInsertFirst

public boolean isInsertFirst()

Oracle insert first

Returns:

Oracle insert first

isMultiTableInsert

public boolean isMultiTableInsert()

Whether this is a multi-table insert, INSERT ALL or INSERT FIRST: the VALUES of its INTO clauses read the select list of its subquery. The two forms differ only in which WHEN branch receives a row, so a rule about what a VALUES name reads must test this, not isInsertAll() alone.

Returns:

true for INSERT ALL and INSERT FIRST

getErrorLoggingClause

public TErrorLoggingClause getErrorLoggingClause()

Oracle error logging clause

Returns:

Oracle error logging clause

getHiveInsertType

public EHiveInsertType getHiveInsertType()

Hive insert type

Returns:

Hive insert type

getDirectoryName

public TObjectName getDirectoryName()

Hive directory name

Returns:

directory name

getInsertConditions

public TPTNodeList<TInsertCondition> getInsertConditions()

Oracle insert condition

Returns:

Oracle insert condition

getInsertIntoValues

public TPTNodeList<TInsertIntoValue> getInsertIntoValues()

Oracle insert into values used after insert all/first clause

Returns:

Oracle insert into values used after insert all/first clause

setInsertToken

public void setInsertToken(TSourceToken insertToken)

getInsertToken

public TSourceToken getInsertToken()

INSERT keyword

Returns:

INSERT keyword

getSubQuery

public TSelectSqlStatement getSubQuery()

value clause valid when getInsertSource() is EInsertSource.subquery.

Returns:

sub-query

getFunctionCall

public TFunctionCall getFunctionCall()

value clause valid when getInsertSource() is EInsertSource.values_function.

Returns:

row value was constructed by a function.

getRecordName

public TObjectName getRecordName()

Oracle PLSQL record name in values clause, getInsertSource() returns EInsertSource.values_oracle_record

Returns:

record name in plsql.

getInsertSource

public EInsertSource getInsertSource()

Type of the source from where the data is coming for this insert statement.

Returns:

Type of the data source

getValueType

public int getValueType()

Deprecated. As of v1.6.4.9, use getInsertSource() instead.

Returns:

how rows was insert into table. value can be one of

vt_values, getValues()

vt_values_empty, syntax like: value ()

vt_query, getSubQuery()

vt_default_values,

vt_execute,

vt_values_function, getFunctionCall()

getValues

public TMultiTargetList getValues()

value clause, valid when getInsertSource() is EInsertSource.values. represents in format like this: ((1,2,3),(4,5),(6,7,8)), if even value clause is (1,2,3), it will be saved in TMultiTargetList like ((1,2,3))

Returns:

a single row value, or multi row values returned by query or value constructor.

getOnDuplicateKeyUpdate

public TResultColumnList getOnDuplicateKeyUpdate()

MySQL on duplicate key update column list.

Returns:

MySQL on duplicate key update column list

getInsertRowAlias

public TObjectName getInsertRowAlias()

Get MySQL 8.0.20+ row alias for INSERT ... ON DUPLICATE KEY UPDATE.

Returns:

the row alias name, or null if not specified

getInsertRowAliasColumnList

public TObjectNameList getInsertRowAliasColumnList()

Get MySQL 8.0.20+ optional column aliases for the row alias.

Returns:

the column alias list, or null if not specified

getOnConflictClause

public TOnConflictClause getOnConflictClause()

PostgreSQL ON CONFLICT clause (UPSERT).

Provides access to the conflict target (columns or constraint name), the action type (DO NOTHING or DO UPDATE), and the SET/WHERE clauses for DO UPDATE actions.

Example:

 INSERT INTO tbl VALUES (1, 2) ON CONFLICT (id) DO UPDATE SET col = EXCLUDED.col;
 

Returns:

the ON CONFLICT clause, or null if not present

getIgnore

public TSourceToken getIgnore()

IGNORE keyword used in the insert statement.

Returns:

IGNORE keyword if used, otherwise, returns null.

getPriority_delayed

public TSourceToken getPriority_delayed()

DELAY, LOW_PRIORITY, HIGH_PRIORITY keyword used in insert statement.

Returns:

null if none of those keywords is used: DELAY, LOW_PRIORITY, HIGH_PRIORITY

getSetColumnValues

public TResultColumnList getSetColumnValues()

set column value clauses in MySQL insert statement.

Returns:

MySQL specific column value list.

getColumnList

public TObjectNameList getColumnList()

columns of the target table.

Returns:

column name list in insert into clause.

setValues

public void setValues(TMultiTargetList values)

setColumnList

public void setColumnList(TObjectNameList columnList)

setSubQuery

public void setSubQuery(TSelectSqlStatement subQuery)

getExecuteStmt

public TMssqlExecute getExecuteStmt()

SQL Server, execute statement used in the insert statement. getInsertSource() returns EInsertSource.execute

Returns:

SQL Server, execute statement

getElseIntoValues

public TPTNodeList<TInsertIntoValue> getElseIntoValues()

Oracle, values in else clause

Returns:

values in else clause

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TCustomSqlStatement

accept

public void accept(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor

Specified by:

accept in interface Visitable

Overrides:

accept in class TParseTreeNode

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

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

setErrorLoggingClause

public void setErrorLoggingClause(TErrorLoggingClause errorLoggingClause)

setHiveInsertType

public void setHiveInsertType(EHiveInsertType hiveInsertType)

setDirectoryName

public void setDirectoryName(TObjectName directoryName)

setInsertConditions

public void setInsertConditions(TPTNodeList<TInsertCondition> insertConditions)

setInsertIntoValues

public void setInsertIntoValues(TPTNodeList<TInsertIntoValue> insertIntoValues)

setFunctionCall

public void setFunctionCall(TFunctionCall functionCall)

setExecuteStmt

public void setExecuteStmt(TMssqlExecute executeStmt)

setRecordName

public void setRecordName(TObjectName recordName)

setInsertSource

public void setInsertSource(EInsertSource insertSource)

setValueType

public void setValueType(int valueType)

setSetColumnValues

public void setSetColumnValues(TResultColumnList setColumnValues)

setOnDuplicateKeyUpdate

public void setOnDuplicateKeyUpdate(TResultColumnList onDuplicateKeyUpdate)