Skip to content
# Class: DeleteQuery

Defined in: packages/core/src/models/DeleteQuery.ts:6

Extends

Constructors

Constructor

new DeleteQuery(params): DeleteQuery

Defined in: packages/core/src/models/DeleteQuery.ts:14

Parameters

params
withClause?

null | WithClause

deleteClause

DeleteClause

usingClause?

null | UsingClause

whereClause?

null | WhereClause

returning?

null | ReturningClause

Returns

DeleteQuery

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

Defined in: packages/core/src/models/DeleteQuery.ts:7

Overrides

SqlComponent.kind


withClause

withClause: null | WithClause

Defined in: packages/core/src/models/DeleteQuery.ts:8


deleteClause

deleteClause: DeleteClause

Defined in: packages/core/src/models/DeleteQuery.ts:9


usingClause

usingClause: null | UsingClause

Defined in: packages/core/src/models/DeleteQuery.ts:10


whereClause

whereClause: null | WhereClause

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


returningClause

returningClause: null | ReturningClause

Defined in: packages/core/src/models/DeleteQuery.ts:12


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

Released under the MIT License.