# Class: IndexColumnDefinition

Defined in: packages/core/src/models/DDLStatements.ts:131

Column definition within CREATE INDEX clause.

Extends

• SqlComponent

Constructors

Constructor

new IndexColumnDefinition(params): IndexColumnDefinition

Defined in: packages/core/src/models/DDLStatements.ts:139

Parameters

params

expression

ValueComponent

sortOrder?

IndexSortOrder

nullsOrder?

IndexNullsOrder

collation?

QualifiedName | null

operatorClass?

QualifiedName | null

Returns

IndexColumnDefinition

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

Defined in: packages/core/src/models/DDLStatements.ts:132

Overrides

SqlComponent.kind

---

expression

expression: ValueComponent

Defined in: packages/core/src/models/DDLStatements.ts:133

---

sortOrder

sortOrder: IndexSortOrder

Defined in: packages/core/src/models/DDLStatements.ts:134

---

nullsOrder

nullsOrder: IndexNullsOrder

Defined in: packages/core/src/models/DDLStatements.ts:135

---

collation?

optional collation: QualifiedName | null

Defined in: packages/core/src/models/DDLStatements.ts:136

---

operatorClass?

optional operatorClass: QualifiedName | null

Defined in: packages/core/src/models/DDLStatements.ts:137

---

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

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