Table of Contents

Class TFunctionCall

Namespace
gudusoft.gsqlparser.nodes
Assembly
gudusoft.gsqlparser.dll

Database built-in function or user defined function called in a SQL query. this class includes function name and arguments.

function([expr,expr, ...])

for Window (or analytic) functions, method AnalyticFunction returns additional information about window information.

Below are functions with special arguments.

trim

cast(expr as typename), cast(expr as typename [,datatypeAttribute]), cast(expr as datatypeAttribute)

convert(typename,[null|not null] expr1 [,expr2]),

extract([time_token from expr]),

sql server contains function,contains(in_expr, expr [,langTerm]),

sql server freetext,freetext(contain in expr, expr [,langTerm]),

Oracle Extract(XML): extract(XMLType_instance, XPath_string[,namespace_string]),

Rank(value,...),

XMLPassingClause of XMLExists function

public class TFunctionCall : TParseTreeNode, Visitable
Inheritance
TFunctionCall
Implements
Inherited Members

Fields

Trim_Expr_Renamed

public TExpression Trim_Expr_Renamed

Field Value

TExpression

Trim_From_Expr_Renamed

public TExpression Trim_From_Expr_Renamed

Field Value

TExpression

fntAddDate

public const int fntAddDate = 32

Field Value

int

fntCSUM

public const int fntCSUM = 16

Field Value

int

fntCaseN

public const int fntCaseN = 10

Field Value

int

fntCast

public const int fntCast = 2

Field Value

int

fntContains

public const int fntContains = 6

Field Value

int

fntConvert

public const int fntConvert = 3

Field Value

int

fntDateAdd

public const int fntDateAdd = 33

Field Value

int

fntDateSub

public const int fntDateSub = 35

Field Value

int

fntExtract

public const int fntExtract = 4

Field Value

int

fntExtractXML

public const int fntExtractXML = 50

Field Value

int

fntFreetext

public const int fntFreetext = 7

Field Value

int

fntGroupConcat

public const int fntGroupConcat = 38

Field Value

int

fntMatchAgainst

public const int fntMatchAgainst = 39

Field Value

int

fntOGC

public const int fntOGC = 60

Field Value

int

fntPosition

public const int fntPosition = 12

Field Value

int

fntRangeN

public const int fntRangeN = 11

Field Value

int

fntRank

public const int fntRank = 17

Field Value

int

fntSubDate

public const int fntSubDate = 34

Field Value

int

fntSubString

public const int fntSubString = 31

Field Value

int

fntTimestampAdd

public const int fntTimestampAdd = 36

Field Value

int

fntTimestampDiff

public const int fntTimestampDiff = 37

Field Value

int

fntTranslate

public const int fntTranslate = 14

Field Value

int

fntTranslateCHK

public const int fntTranslateCHK = 15

Field Value

int

fntTreat

public const int fntTreat = 5

Field Value

int

fntTrim

public const int fntTrim = 1

Field Value

int

fntUdf

public const int fntUdf = 0

Field Value

int

fntXmlQuery

public const int fntXmlQuery = 18

Field Value

int

Properties

AgainstExpr

against expr in match function of MySQL @return

public virtual TExpression AgainstExpr { get; set; }

Property Value

TExpression

AggregateType

public virtual EAggregateType AggregateType { get; set; }

Property Value

EAggregateType

AnalyticFunction

public virtual TAnalyticFunction AnalyticFunction { get; set; }

Property Value

TAnalyticFunction

Args

public virtual TExpressionList Args { get; set; }

Property Value

TExpressionList

AsDatatype

public virtual TTypeName AsDatatype { get; set; }

Property Value

TTypeName

BetweenExpr

public virtual TExpression BetweenExpr { get; set; }

Property Value

TExpression

BuiltIn

public virtual bool BuiltIn { set; }

Property Value

bool

CallTarget

public virtual TExpressionCallTarget CallTarget { get; set; }

Property Value

TExpressionCallTarget

CastOperand

public TExpression CastOperand { get; set; }

Property Value

TExpression

CheckedBuiltIn

public virtual bool CheckedBuiltIn { set; }

Property Value

bool

DatatypeAttribute

public virtual TDatatypeAttribute DatatypeAttribute { get; set; }

Property Value

TDatatypeAttribute

Dummy

public virtual TDummy Dummy { get; set; }

Property Value

TDummy

Expr1

public virtual TExpression Expr1 { get; set; }

Property Value

TExpression

Expr2

public virtual TExpression Expr2 { get; set; }

Property Value

TExpression

Expr3

public virtual TExpression Expr3 { get; set; }

Property Value

TExpression

ExprList

public virtual TExpressionList ExprList { get; set; }

Property Value

TExpressionList

ExtractXMLArg

public virtual TExpressionList ExtractXMLArg { set; }

Property Value

TExpressionList

Extract_time_token

public virtual TSourceToken Extract_time_token { get; set; }

Property Value

TSourceToken

FuncType

public virtual int FuncType { get; set; }

Property Value

int

FunctionName

public virtual TObjectName FunctionName { get; set; }

Property Value

TObjectName

FunctionType

public virtual EFunctionType FunctionType { get; set; }

Property Value

EFunctionType

GroupConcatParam

public virtual TGroupConcatParam GroupConcatParam { get; set; }

Property Value

TGroupConcatParam

InExpr

public virtual TInExpr InExpr { get; set; }

Property Value

TInExpr

MatchColumns

column list in match function of MySQL @return

public virtual TObjectNameList MatchColumns { get; set; }

Property Value

TObjectNameList

Namespace_String

public virtual TExpression Namespace_String { get; set; }

Property Value

TExpression

OrderByList

public virtual TOrderByItemList OrderByList { get; set; }

Property Value

TOrderByItemList

Parameter

public TExpression Parameter { get; set; }

Property Value

TExpression

PassingClause

public virtual TXMLPassingClause PassingClause { get; set; }

Property Value

TXMLPassingClause

RangeSize

public virtual TExpression RangeSize { get; set; }

Property Value

TExpression

SeparatorExpr

the second argument of the listagg function.

public TExpression SeparatorExpr { get; set; }

Property Value

TExpression

SortClause

public virtual TOrderBy SortClause { get; set; }

Property Value

TOrderBy

StringExpr

DB2 listagg function, the first argument of the listagg function

public TExpression StringExpr { get; set; }

Property Value

TExpression

Style

public TExpression Style { get; set; }

Property Value

TExpression

TrimArgument

public virtual TTrimArgument TrimArgument { get; set; }

Property Value

TTrimArgument

Trim_Expr

public virtual TExpression Trim_Expr { set; }

Property Value

TExpression

Trim_From_Expr

public virtual TExpression Trim_From_Expr { set; }

Property Value

TExpression

Typename

public virtual TTypeName Typename { get; set; }

Property Value

TTypeName

WindowDef

Over clause of window function @return

public virtual TWindowDef WindowDef { get; set; }

Property Value

TWindowDef

WindowSpecification

public virtual TWindowSpecification WindowSpecification { get; set; }

Property Value

TWindowSpecification

XMLAttributesClause

public virtual TXMLAttributesClause XMLAttributesClause { get; set; }

Property Value

TXMLAttributesClause

XMLElementNameExpr

public virtual TExpression XMLElementNameExpr { get; set; }

Property Value

TExpression

XMLElementValueExprList

public virtual TResultColumnList XMLElementValueExprList { get; set; }

Property Value

TResultColumnList

XMLForestValueList

public virtual TResultColumnList XMLForestValueList { get; set; }

Property Value

TResultColumnList

XMLType_Instance

public virtual TExpression XMLType_Instance { get; set; }

Property Value

TExpression

XPath_String

public virtual TExpression XPath_String { get; set; }

Property Value

TExpression

Methods

accept(TParseTreeVisitor)

public override void accept(TParseTreeVisitor v)

Parameters

v TParseTreeVisitor

acceptChildren(TParseTreeVisitor)

public override void acceptChildren(TParseTreeVisitor v)

Parameters

v TParseTreeVisitor

doParse(TCustomSqlStatement, ESqlClause)

analyze this node

public override void doParse(TCustomSqlStatement psql, ESqlClause plocation)

Parameters

psql TCustomSqlStatement
plocation ESqlClause

init(object)

Initialize a query tree node.

public override void init(object arg1)

Parameters

arg1 object

init(object, object)

public override void init(object arg1, object arg2)

Parameters

arg1 object
arg2 object

isBuiltIn(string, EDbVendor)

public static bool isBuiltIn(string pName, EDbVendor pDBVendor)

Parameters

pName string
pDBVendor EDbVendor

Returns

bool

isBuiltIn(EDbVendor)

public virtual bool isBuiltIn(EDbVendor pDBVendor)

Parameters

pDBVendor EDbVendor

Returns

bool

setAggregateType(EAggregateType)

public void setAggregateType(EAggregateType at)

Parameters

at EAggregateType

setAnalyticFunction(TAnalyticFunction)

public void setAnalyticFunction(TAnalyticFunction af)

Parameters

af TAnalyticFunction

setArgs(TExpressionList)

public void setArgs(TExpressionList el)

Parameters

el TExpressionList

setExpr1(TExpression)

public void setExpr1(TExpression e)

Parameters

e TExpression

setExpr2(TExpression)

public void setExpr2(TExpression e)

Parameters

e TExpression

setExpr3(TExpression)

public void setExpr3(TExpression e)

Parameters

e TExpression

setExtractXMLArg(TExpressionList)

public void setExtractXMLArg(TExpressionList l)

Parameters

l TExpressionList

setExtract_time_token(TSourceToken)

public void setExtract_time_token(TSourceToken st)

Parameters

st TSourceToken

setFuncType(int)

public void setFuncType(int ft)

Parameters

ft int

setSortClause(TOrderBy)

public void setSortClause(TOrderBy b)

Parameters

b TOrderBy

setTrimArgument(TTrimArgument)

public void setTrimArgument(TTrimArgument ta)

Parameters

ta TTrimArgument

setTypename(TTypeName)

public void setTypename(TTypeName tn)

Parameters

tn TTypeName

setWindowDef(TWindowDef)

public void setWindowDef(TWindowDef w)

Parameters

w TWindowDef