# Abstract Class: SqlComponent

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

Extended by

• BinarySelectQuery
• SelectQuery
• InlineQuery
• ValueList
• ColumnReference
• FunctionCall
• WindowFrameBoundStatic
• WindowFrameBoundaryValue
• WindowFrameSpec
• WindowFrameExpression
• UnaryExpression
• BinaryExpression
• LiteralValue
• ParameterExpression
• SwitchCaseArgument
• CaseKeyValuePair
• RawString
• IdentifierString
• ParenExpression
• CastExpression
• CaseExpression
• ArrayExpression
• ArrayQueryExpression
• BetweenExpression
• StringSpecifierExpression
• TypeValue
• TupleExpression
• ArraySliceExpression
• ArrayIndexExpression
• QualifiedName
• ReferenceDefinition
• ColumnConstraintDefinition
• TableConstraintDefinition
• TableColumnDefinition
• CreateTableQuery
• MergeAction
• MergeWhenClause
• DropTableStatement
• DropIndexStatement
• IndexColumnDefinition
• CreateIndexStatement
• AlterTableAddConstraint
• AlterTableDropConstraint
• AlterTableDropColumn
• AlterTableStatement
• DropConstraintStatement
• ExplainOption
• ExplainStatement
• AnalyzeStatement
• SimpleSelectQuery
• ValuesQuery
• InsertQuery
• UpdateQuery
• DeleteQuery
• MergeQuery

Constructors

Constructor

new SqlComponent(): SqlComponent

Returns

SqlComponent

Properties

kind

static kind: symbol

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

---

comments

comments: null | string[] = null

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

---

positionedComments

positionedComments: null | PositionedComment[] = null

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

Methods

getKind()

getKind(): symbol

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

Returns

symbol

---

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

---

toSqlString()

toSqlString(formatter): string

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

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

---

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

---

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[]

---

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[]