# Class: FunctionSource

Defined in: packages/core/src/models/Clause.ts:194

Extends

• SqlComponent

Constructors

Constructor

new FunctionSource(name, argument): FunctionSource

Defined in: packages/core/src/models/Clause.ts:198

Parameters

name

string | IdentifierString | { namespaces: null | string[] | IdentifierString[]; name: string | RawString | IdentifierString; }

argument

null | ValueComponent

Returns

FunctionSource

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

Defined in: packages/core/src/models/Clause.ts:195

Overrides

SqlComponent.kind

---

qualifiedName

qualifiedName: QualifiedName

Defined in: packages/core/src/models/Clause.ts:196

---

argument

argument: null | ValueComponent

Defined in: packages/core/src/models/Clause.ts:197

---

comments

comments: null | string[] = null

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

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: null | PositionedComment[] = null

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

Inherited from

SqlComponent.positionedComments

Accessors

namespaces

Get Signature

get namespaces(): null | IdentifierString[]

Defined in: packages/core/src/models/Clause.ts:216

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/Clause.ts:222

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