Package gudusoft.gsqlparser.stmt

Class TCreateFunctionStmt

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TBlockSqlStatement

gudusoft.gsqlparser.stmt.TStoredProcedureSqlStatement

gudusoft.gsqlparser.stmt.TCommonStoredProcedureSqlStatement

gudusoft.gsqlparser.stmt.TRoutine

gudusoft.gsqlparser.stmt.TCreateFunctionStmt

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

Direct Known Subclasses:

TMssqlCreateFunction

public class TCreateFunctionStmt
extends TRoutine

Create function. Supported database:

• BigQuery

Nested Class Summary

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

TCustomSqlStatement.SqlNormalizationProfile

Field Summary

Fields inherited from class gudusoft.gsqlparser.stmt.TRoutine

language, LANGUAGE_PLPGSQL, LANGUAGE_SQL, LANGUAGE_UNKNOWN

Fields inherited from class gudusoft.gsqlparser.stmt.TBlockSqlStatement

blockBody, bodyStatements, declareStatements, exceptionClause

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	Description
TCreateFunctionStmt(EDbVendor dbvendor)

Method Summary

Modifier and Type	Method	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)
TMssqlBlock	getBlock()
String	getClassName()
TConstant	getFunctionDefinition()
TObjectName	getFunctionName()	The name that you give to the function that you are declaring or defining.
int	getFunctionType()	this is used for backward compatibility of .NET version TMssqlCreateFunction.functiontype please use returnMode in java version
TConstant	getLinkSymbol()
TConstant	getObjfile()
TConstant	getProcedureLanguage()
TPTNodeList<TProcedureOption>	getProcedureOptions()
String	getResourceType()
String	getResourceURI()
TTypeName	getReturnDataType()
int	getReturnMode()
TMssqlReturn	getReturnStmt()
EFunctionReturnsType	getReturnsType()
TTableElementList	getReturnTableDefinitions()	when getReturnsType() == EFunctionReturnsType.frtMultiStatementTableValue returns this table_type_definition
TObjectName	getReturnTableVaraible()
String	getSharedLibraryName()
TExpression	getSqlExpression()
TSelectSqlStatement	getSqlQuery()
TObjectName	getStoredProcedureName()
void	setBlock(TMssqlBlock block)
void	setFunctionName(TObjectName functionName)
void	setFunctionType(int functionType)
void	setProcedureOptions(TPTNodeList<TProcedureOption> procedureOptions)
void	setReturnDataType(TTypeName returnDataType)
void	setReturnMode(int returnMode)
void	setReturnStmt(TMssqlReturn returnStmt)
void	setReturnTableDefinitions(TTableElementList returnTableDefinitions)
void	setReturnTableVaraible(TObjectName returnTableVaraible)
void	setSqlExpression(TExpression sqlExpression)

Methods inherited from class gudusoft.gsqlparser.stmt.TRoutine

getRoutineBody, getRoutineBodyInConstant, getRoutineLanguage, getRoutineLanguageInConstant, getRoutineName, isBodyInSQL, isGaussDBSpInOracle, setRoutineBody, setRoutineBodyInConstant, setRoutineLanguage, setRoutineLanguageInConstant, setRoutineName

Methods inherited from class gudusoft.gsqlparser.stmt.TCommonStoredProcedureSqlStatement

isWrapped, setWrapped

Methods inherited from class gudusoft.gsqlparser.stmt.TStoredProcedureSqlStatement

getParameterDeclarations, getProcHandle, setParameterDeclarations, setProcHandle

Methods inherited from class gudusoft.gsqlparser.stmt.TBlockSqlStatement

getBlockBody, getBodyStatements, getDeclareStatements, getEndlabelName, getExceptionClause, getLabelName, getLabelNameStr, setBodyStatements, setDeclareStatements, setExceptionClause

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, getErrorCount, getErrormessage, getExpandedResultColumns, getFirstPhysicalTable, getFrameStack, getFromClause, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, 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, isnzplsql, isoracleplsql, 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, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, doParse, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getPlainText, getStartToken, getTokenCount, hasNext, 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 java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

TCreateFunctionStmt

public TCreateFunctionStmt(EDbVendor dbvendor)

Method Details

setProcedureOptions

public void setProcedureOptions(TPTNodeList<TProcedureOption> procedureOptions)

getProcedureOptions

public TPTNodeList<TProcedureOption> getProcedureOptions()

getStoredProcedureName

public TObjectName getStoredProcedureName()

Overrides:

getStoredProcedureName in class TStoredProcedureSqlStatement

getFunctionName

public TObjectName getFunctionName()

The name that you give to the function that you are declaring or defining.

Returns:

getReturnsType

public EFunctionReturnsType getReturnsType()

getReturnMode

public int getReturnMode()

getBlock

public TMssqlBlock getBlock()

Returns:

statements in create function

getReturnStmt

public TMssqlReturn getReturnStmt()

Returns:

this is the only return statement in create function.

getReturnTableVaraible

public TObjectName getReturnTableVaraible()

getReturnTableDefinitions

public TTableElementList getReturnTableDefinitions()

when getReturnsType() == EFunctionReturnsType.frtMultiStatementTableValue returns this table_type_definition

Returns:

table_type_definition

getReturnDataType

public TTypeName getReturnDataType()

Overrides:

getReturnDataType in class TRoutine

getFunctionType

public int getFunctionType()

this is used for backward compatibility of .NET version TMssqlCreateFunction.functiontype please use returnMode in java version

Returns:

getObjfile

public TConstant getObjfile()

getLinkSymbol

public TConstant getLinkSymbol()

getClassName

public String getClassName()

getResourceType

public String getResourceType()

getResourceURI

public String getResourceURI()

setSqlExpression

public void setSqlExpression(TExpression sqlExpression)

getSqlExpression

public TExpression getSqlExpression()

getSharedLibraryName

public String getSharedLibraryName()

getFunctionDefinition

public TConstant getFunctionDefinition()

getProcedureLanguage

public TConstant getProcedureLanguage()

getSqlQuery

public TSelectSqlStatement getSqlQuery()

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TCommonStoredProcedureSqlStatement

accept

public void accept(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor

Specified by:

accept in interface Visitable

Overrides:

accept in class TBlockSqlStatement

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 TBlockSqlStatement

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

setFunctionName

public void setFunctionName(TObjectName functionName)

setBlock

public void setBlock(TMssqlBlock block)

setReturnStmt

public void setReturnStmt(TMssqlReturn returnStmt)

setReturnMode

public void setReturnMode(int returnMode)

setReturnTableVaraible

public void setReturnTableVaraible(TObjectName returnTableVaraible)

setReturnTableDefinitions

public void setReturnTableDefinitions(TTableElementList returnTableDefinitions)

setReturnDataType

public void setReturnDataType(TTypeName returnDataType)

Overrides:

setReturnDataType in class TRoutine

setFunctionType

public void setFunctionType(int functionType)