GitHub

RecordUpdateHelper

API reference for RecordUpdateHelper.

Rows for a multi-row update, as a VALUES list named alias (escaped, never renamed). Not supported by SQLite.

Attributes

AttributeTypeDescription
valuetuple[Mapping[str, object], ...]
aliasstr
returning_identifierReturning = field(default=None, kw_only=True)

Functions

__init__

__init__(value, alias, *, returning_identifier=None) -> None
ParameterTypeDescription
valuetuple[Mapping[str, object], ...]
aliasstr
returning_identifierReturning = None

returning

returning(sql) -> Self
ParameterTypeDescription
sqlLiteralString | Identifier | Fragment

Returns Self

def returning(self, sql: LiteralString | Identifier | Fragment) -> Self:
    return replace(self, returning_identifier=_returning(sql))