# Class: UpdateQuery

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

Extends

• SqlComponent

Constructors

Constructor

new UpdateQuery(params): UpdateQuery

Defined in: packages/core/src/models/UpdateQuery.ts:25

Parameters

params

withClause?

WithClause | null

updateClause

UpdateClause

setClause

SetClause | object[]

SetClause instance or array of {column, value} pairs

whereClause?

WhereClause | null

fromClause?

FromClause | null

returning?

ReturningClause | null

RETURNING clause (optional)

Returns

UpdateQuery

Overrides

SqlComponent.constructor

Properties

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

---

kind

static kind: symbol

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

Overrides

SqlComponent.kind

---

withClause

withClause: WithClause | null

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

---

updateClause

updateClause: UpdateClause

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

---

setClause

setClause: SetClause

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

---

whereClause

whereClause: WhereClause | null

Defined in: packages/core/src/models/UpdateQuery.ts:13

---

fromClause

fromClause: FromClause | null

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

---

returningClause

returningClause: ReturningClause | null

Defined in: packages/core/src/models/UpdateQuery.ts:15

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