gudusoft.gsqlparser.stmt

Class TCursorDeclStmt

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TCursorDeclStmt

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TCursorDeclStmt
extends TCustomSqlStatement

Represents cursor related statement, including:

Cursor declaration

Cursor specification

Cursor body

Ref cursor type definition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TCursorDeclStmt.CursorKind

Field Summary

Fields

Modifier and Type	Field and Description
static int	kind_cursor_body
static int	kind_cursor_declaration
static int	kind_cursor_specification
static int	kind_ref_cursor_type_definition

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

dummytag, fromClause, fromSourceJoin, fromSourceTable, isparsed, joins, parser, plsqlparser, relationAttributes, rootNode, 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
TCursorDeclStmt()
TCursorDeclStmt(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)
TCursorDeclStmt.CursorKind	getCursorKind()
TObjectName	getCursorName() Name of an explicit cursor.
TParameterDeclarationList	getCursorParameterDeclarations() List of cursor parameter declaration, which is represented by TParameterDeclaration.
TObjectName	getCursorTypeName() Name of a REF CURSOR type.
int	getKind() Deprecated. since 2.5.0.9, please use getCursorKind() instead.
TObjectName	getResultsetName()
TTypeName	getRowtype() A record type that represents a row in a database table or a row fetched from a previously declared cursor or cursor variable.
TSelectSqlStatement	getSubquery() A SQL SELECT statement.
void	init(Object arg1) Initialize a query tree node.
void	init(Object arg1, Object arg2)
void	setCursorName(TObjectName cursorName)
void	setCursorParameterDeclarations(TParameterDeclarationList cursorParameterDeclarations)
void	setCursorTypeName(TObjectName cursorTypeName)
void	setKind(int kind)
void	setRowtype(TTypeName rowtype)
void	setSubquery(TSelectSqlStatement subquery)

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

addToTables, addWhereClause, analyzeFromTable, analyzeFromTable, analyzeJoin, analyzeTablename, analyzeTableOrJoin, asCanonical, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, 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, getRelationName, getRelations, getResultColumnList, getReturningClause, getSqlEnv, 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, setResultColumnList, setReturningClause, setStmtScope, setTargetTable, setTopClause, setUsingVariableList, setVariableStack, setWhereClause, size, 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, 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

Field Detail

kind_cursor_declaration

public static final int kind_cursor_declaration

See Also:

Constant Field Values

kind_cursor_specification

public static final int kind_cursor_specification

See Also:

Constant Field Values

kind_cursor_body

public static final int kind_cursor_body

See Also:

Constant Field Values

kind_ref_cursor_type_definition

public static final int kind_ref_cursor_type_definition

See Also:

Constant Field Values

Constructor Detail

TCursorDeclStmt

public TCursorDeclStmt()

TCursorDeclStmt

public TCursorDeclStmt(EDbVendor dbvendor)

Method Detail

getCursorKind

public TCursorDeclStmt.CursorKind getCursorKind()

setKind

public void setKind(int kind)

getKind

public int getKind()

Deprecated. since 2.5.0.9, please use getCursorKind() instead.

what's kind of SQL statement this class represents for.

getSubquery

public TSelectSqlStatement getSubquery()

A SQL SELECT statement. If the cursor declaration declares parameters, each parameter must appear in select_statement.

Returns:

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TCustomSqlStatement

getResultsetName

public TObjectName getResultsetName()

init

public void init(Object arg1)

Description copied from class: TParseTreeNode

Initialize a query tree node. Used internally

Overrides:

init in class TParseTreeNode

Parameters:

arg1 - first argument

init

public void init(Object arg1,
                 Object arg2)

Overrides:

init in class TParseTreeNode

setCursorName

public void setCursorName(TObjectName cursorName)

getCursorName

public TObjectName getCursorName()

Name of an explicit cursor.

Returns:

getCursorParameterDeclarations

public TParameterDeclarationList getCursorParameterDeclarations()

List of cursor parameter declaration, which is represented by TParameterDeclaration.

Returns:

setCursorParameterDeclarations

public void setCursorParameterDeclarations(TParameterDeclarationList cursorParameterDeclarations)

setRowtype

public void setRowtype(TTypeName rowtype)

getRowtype

public TTypeName getRowtype()

A record type that represents a row in a database table or a row fetched from a previously declared cursor or cursor variable.

Returns:

setCursorTypeName

public void setCursorTypeName(TObjectName cursorTypeName)

getCursorTypeName

public TObjectName getCursorTypeName()

Name of a REF CURSOR type. Valid only when kind = kind_ref_cursor_type_definition To create a cursor variable, define a REF CURSOR type, and then declare the cursor variable to be of that type. Declaring a cursor variable creates a pointer, not an item.

Returns:

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

setSubquery

public void setSubquery(TSelectSqlStatement subquery)