Skip to content
# Class: QualifiedName

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

Represents a qualified name with optional namespaces (e.g. schema.table, db.schema.function)

Extends ​

Constructors ​

Constructor ​

new QualifiedName(namespaces, name): QualifiedName

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

Parameters ​

namespaces ​

string | string[] | IdentifierString[] | null

name ​

string | RawString | IdentifierString

Returns ​

QualifiedName

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

Overrides ​

SqlComponent.kind


namespaces ​

namespaces: IdentifierString[] | null

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

List of namespaces (e.g. schema, database)


name ​

name: RawString | IdentifierString

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

The actual name (e.g. table, function, type, column)

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

Returns the full qualified name as a string (dot-separated)

Returns ​

string

Released under the MIT License.