# Class: CreateIndexStatement

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

CREATE INDEX statement representation.

Extends

• SqlComponent

Constructors

Constructor

new CreateIndexStatement(params): CreateIndexStatement

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

Parameters

params

unique?

boolean

concurrently?

boolean

ifNotExists?

boolean

indexName

QualifiedName

tableName

QualifiedName

usingMethod?

null | RawString | IdentifierString

columns

IndexColumnDefinition[]

include?

null | IdentifierString[]

where?

ValueComponent

withOptions?

null | RawString

tablespace?

null | IdentifierString

Returns

CreateIndexStatement

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

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

Overrides

SqlComponent.kind

---

unique

unique: boolean

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

---

concurrently

concurrently: boolean

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

---

ifNotExists

ifNotExists: boolean

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

---

indexName

indexName: QualifiedName

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

---

tableName

tableName: QualifiedName

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

---

usingMethod?

optional usingMethod: null | RawString | IdentifierString

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

---

columns

columns: IndexColumnDefinition[]

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

---

include?

optional include: null | IdentifierString[]

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

---

where?

optional where: ValueComponent

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

---

withOptions?

optional withOptions: null | RawString

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

---

tablespace?

optional tablespace: null | IdentifierString

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

---

comments

comments: null | string[] = null

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

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: null | PositionedComment[] = 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