# Class: FunctionCall

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

Extends

• SqlComponent

Constructors

Constructor

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

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

Parameters

namespaces

null | string | string[] | IdentifierString[]

name

string | RawString | IdentifierString

argument

null | ValueComponent

over

null | OverExpression

withinGroup

null | OrderByClause

withOrdinality

boolean = false

internalOrderBy

null | OrderByClause

Returns

FunctionCall

Overrides

SqlComponent.constructor

Properties

comments

comments: null | string[] = null

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

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: null | PositionedComment[] = null

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

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: null | ValueComponent

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

---

over

over: null | OverExpression

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

---

withinGroup

withinGroup: null | OrderByClause

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

---

withOrdinality

withOrdinality: boolean

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

---

internalOrderBy

internalOrderBy: null | OrderByClause

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

Accessors

namespaces

Get Signature

get namespaces(): null | IdentifierString[]

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

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

Returns

null | IdentifierString[]

---

name

Get Signature

get name(): RawString | IdentifierString

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

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:13

Returns

symbol

Inherited from

SqlComponent.getKind

---

accept()

accept<T&gt;(visitor): T

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

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:21

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

Inherited from

SqlComponent.toSqlString

---

addPositionedComments()

addPositionedComments(position, comments): void

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

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:54

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:64

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

Returns

string[]

Inherited from

SqlComponent.getAllPositionedComments