# Class: ExplainStatement

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

EXPLAIN statement representation.

Extends

• SqlComponent

Constructors

Constructor

new ExplainStatement(params): ExplainStatement

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

Parameters

params

options?

null | ExplainOption[]

statement

SqlComponent

Returns

ExplainStatement

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

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

Overrides

SqlComponent.kind

---

options

options: null | ExplainOption[]

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

---

statement

statement: SqlComponent

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

---

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