Structure

SQLUpdate

An expression representing an UPDATE query. Used to modify existing rows in a single table.

struct SQLUpdate

Overview

UPDATE "table" SET
    "column1"=$0,
    "column2"=$1
WHERE
    "column3"!=$2
RETURNING
    "id"
;

Because of the radically different syntax required for “multi-table” updates between dialects, additional dialect support would be required to implement this functionality; this is planned for the next major update to SQLKit.

See SQLUpdateBuilder.

Topics

Initializers

init(table: any SQLExpression)
Create a new row modification query.

Instance Properties

var predicate: (any SQLExpression)?
If not nil, a predicate which describes the row(s) to be updated.
var returning: SQLReturning?
An optional SQLReturning clause specifying data to return from the updated rows.
var table: any SQLExpression
The table containing the row(s) to be updated.
var tableExpressionGroup: SQLCommonTableExpressionGroup?
An optional common table expression group.
var values: [any SQLExpression]
One or more column assignment expressions describing how to update the value in each affected row.

Instance Methods

func serialize(to: inout SQLSerializer)
Invoked when a request is made to serialize the expression to raw SQL.

Relationships

Conforms To

SQLExpression
Swift.Sendable
Swift.SendableMetatype

See Also

Query Expressions

struct SQLAlterEnum
An expression representing an ALTER TYPE query. Used to add new cases to enumeration types.
struct SQLAlterTable
An expression representing an ALTER TABLE query. Used to modify the structure of existing tables.
struct SQLCreateEnum
An expression representing a CREATE TYPE query. Used to create enumeration types.
struct SQLCreateIndex
An expression representing a CREATE INDEX query. Used to add indexes over columns to an existing table.
struct SQLCreateTable
An expression representing a CREATE TABLE query. Used to create new tables.
struct SQLCreateTrigger
An expression representing a CREATE TRIGGER query. Used to create new triggers for actions on a table.
struct SQLDelete
An expression representing a CREATE TRIGGER query. Used to remove rows from a table.
struct SQLDropEnum
An expression representing a DROP TYPE query. Used to delete enumeration types.
struct SQLDropIndex
An expression representing a DROP INDEX query. Used to delete indexes from tables.
struct SQLDropTable
An expression representing a DROP TABLE query. Used to delete entire tables.
struct SQLDropTrigger
An expression representing a DROP TRIGGER query. Used to delete triggers.
struct SQLInsert
An expression representing an INSERT query. Used to add new rows to a table.
struct SQLSelect
An expression representing a SELECT query. Used to retrieve rows and expression results from a database.
struct SQLUnion
An expression representing two or more SELECT queries joined by UNION clauses. Used to merge the results of multiple queries into a single result set.