Skip to content
# Class: ColumnReference

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

Extends ​

Constructors ​

Constructor ​

new ColumnReference(namespaces, column): ColumnReference

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

Parameters ​

namespaces ​

string | string[] | IdentifierString[] | null

column ​

string | IdentifierString

Returns ​

ColumnReference

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

Overrides ​

SqlComponent.kind


qualifiedName ​

qualifiedName: QualifiedName

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

Accessors ​

namespaces ​

Get Signature ​

get namespaces(): IdentifierString[] | null

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

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

Returns ​

IdentifierString[] | null


column ​

Get Signature ​

get column(): IdentifierString

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

For backward compatibility: returns the column name as IdentifierString (readonly)

Returns ​

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


toString() ​

toString(): string

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

Returns a string representation of an object.

Returns ​

string


getNamespace() ​

getNamespace(): string

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

Returns ​

string

Released under the MIT License.