# Class: CreateIndexStatement

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

CREATE INDEX statement representation.

Extends

• SqlComponent

Constructors

Constructor

new CreateIndexStatement(params): CreateIndexStatement

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

Parameters

params

unique?

boolean

concurrently?

boolean

ifNotExists?

boolean

indexName

QualifiedName

tableName

QualifiedName

usingMethod?

RawString | IdentifierString | null

columns

IndexColumnDefinition[]

include?

IdentifierString[] | null

where?

ValueComponent

withOptions?

RawString | null

tablespace?

IdentifierString | null

Returns

CreateIndexStatement

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

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

Overrides

SqlComponent.kind

---

unique

unique: boolean

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

---

concurrently

concurrently: boolean

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

---

ifNotExists

ifNotExists: boolean

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

---

indexName

indexName: QualifiedName

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

---

tableName

tableName: QualifiedName

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

---

usingMethod?

optional usingMethod: RawString | IdentifierString | null

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

---

columns

columns: IndexColumnDefinition[]

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

---

include?

optional include: IdentifierString[] | null

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

---

where?

optional where: ValueComponent

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

---

withOptions?

optional withOptions: RawString | null

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

---

tablespace?

optional tablespace: IdentifierString | null

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

---

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