Skip to content
# Class: QualifiedName

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

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

Parameters

namespaces

null | string | string[] | IdentifierString[]

name

string | RawString | IdentifierString

Returns

QualifiedName

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

Overrides

SqlComponent.kind


namespaces

namespaces: null | IdentifierString[]

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

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


name

name: RawString | IdentifierString

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

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

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


toString()

toString(): string

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

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

Returns

string

Released under the MIT License.