# Class: FunctionCall

Defined in: packages/core/src/models/ValueComponent.ts:84

Extends

• SqlComponent

Constructors

Constructor

new FunctionCall(namespaces, name, argument, over, withinGroup, withOrdinality, internalOrderBy, filterCondition): FunctionCall

Defined in: packages/core/src/models/ValueComponent.ts:94

Parameters

namespaces

string | string[] | IdentifierString[] | null

name

string | RawString | IdentifierString

argument

ValueComponent | null

over

OverExpression | null

withinGroup

OrderByClause | null

withOrdinality

boolean = false

internalOrderBy

OrderByClause | null

filterCondition

ValueComponent | null

Returns

FunctionCall

Overrides

SqlComponent.constructor

Properties

comments

comments: string[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:29

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: PositionedComment[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:32

Inherited from

SqlComponent.positionedComments

---

kind

static kind: symbol

Defined in: packages/core/src/models/ValueComponent.ts:85

Overrides

SqlComponent.kind

---

qualifiedName

qualifiedName: QualifiedName

Defined in: packages/core/src/models/ValueComponent.ts:86

---

argument

argument: ValueComponent | null

Defined in: packages/core/src/models/ValueComponent.ts:87

---

over

over: OverExpression | null

Defined in: packages/core/src/models/ValueComponent.ts:88

---

withinGroup

withinGroup: OrderByClause | null

Defined in: packages/core/src/models/ValueComponent.ts:89

---

withOrdinality

withOrdinality: boolean

Defined in: packages/core/src/models/ValueComponent.ts:90

---

internalOrderBy

internalOrderBy: OrderByClause | null

Defined in: packages/core/src/models/ValueComponent.ts:91

---

filterCondition

filterCondition: ValueComponent | null

Defined in: packages/core/src/models/ValueComponent.ts:92

Accessors

namespaces

Get Signature

get namespaces(): IdentifierString[] | null

Defined in: packages/core/src/models/ValueComponent.ts:117

For backward compatibility: returns the namespaces as IdentifierString[] | null (readonly)

Returns

IdentifierString[] | null

---

name

Get Signature

get name(): RawString | IdentifierString

Defined in: packages/core/src/models/ValueComponent.ts:123

For backward compatibility: returns the function name as RawString | IdentifierString (readonly)

Returns

RawString | IdentifierString

Methods

getKind()

getKind(): symbol

Defined in: packages/core/src/models/SqlComponent.ts:15

Returns

symbol

Inherited from

SqlComponent.getKind

---

accept()

accept<T&gt;(visitor): T

Defined in: packages/core/src/models/SqlComponent.ts:19

Type Parameters

T

T

Parameters

visitor

SqlComponentVisitor<T&gt;

Returns

T

Inherited from

SqlComponent.accept

---

toSqlString()

toSqlString(formatter): string

Defined in: packages/core/src/models/SqlComponent.ts:23

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

Inherited from

SqlComponent.toSqlString

---

addPositionedComments()

addPositionedComments(position, comments): void

Defined in: packages/core/src/models/SqlComponent.ts:37

Add comments at a specific position

Parameters

position

"before" | "after"

comments

string[]

Returns

void

Inherited from

SqlComponent.addPositionedComments

---

getPositionedComments()

getPositionedComments(position): string[]

Defined in: packages/core/src/models/SqlComponent.ts:56

Get comments for a specific position

Parameters

position

"before" | "after"

Returns

string[]

Inherited from

SqlComponent.getPositionedComments

---

getAllPositionedComments()

getAllPositionedComments(): string[]

Defined in: packages/core/src/models/SqlComponent.ts:66

Get all positioned comments as a flat array in order (before, after)

Returns

string[]

Inherited from

SqlComponent.getAllPositionedComments