Generated query files return row counts for simple mutators #4578

MariusVolkhart · 2023-08-30T17:35:21Z

Simple mutators like INSERT, UPDATE, and DELETE, without RETURNING clauses, typically return the number of rows changed. In fact, the SqlDriver#execute() function already does this. However, the value of execute() is not exposed to the generated query files.

This commit makes it so that simple INSERT, UPDATE, and DELETE statements return the QueryResult that the SqlDriver already returns.

Review Guide

In short, this commit turns

fun updatePlayerName(id: Long, name: String)

into

fun updatePlayerName(id: Long, name: String): QueryResult<Long>

The main logic changes are in ExecuteQueryGenerator and QueryGenerator.

morki · 2023-09-02T06:32:53Z

This can also somewhat fix #3238 and make the behaviour consistent

morki · 2023-09-02T06:34:21Z

But for backward compatibility, it should be behind some flag which will default to false.

MariusVolkhart · 2023-10-24T14:35:38Z

@morki What backwards compatibility are you concerned about? This doesn't change the query behavior, only the API of generated code (but only the return value, so should be source-compatible).

morki · 2023-10-24T14:41:47Z

@MariusVolkhart as I understand this, it can compile fine, but it changes the behaviour. From your example:

updatePlayerName(4, "Hero")

This now normally executes the query. But with your change, the same compiles fine, but does not execute the query. This code will execute the query:

updatePlayerName(4, "Hero").executeAsOne()

Do I understand it right?

MariusVolkhart · 2023-11-06T19:46:24Z

@morki Oh, gotcha. No, that's not how this works.

In the example,

updatePlayerName(4, "Hero").executeAsOne()

updatePlayerName would have to return an ExecutableQuery. The ExecutableQuery allows the query execution to be deferred and this deference is what would cause a behavior change.

However, in the changes in this PR, updatePlayerName returns a QueryResult. The query is still executed immediately, as it was before. The only change is that the result of the query, which was already reported by the driver, is now exposed. That is to say, this PR does not change query execution behavior, only exposes and additional result that is already immediately available. See https://github.com/cashapp/sqldelight/pull/4578/files#diff-3d7267ef64e0f3f32d17e8f5379be391dcf82cecd259a4b42cff03c8ed105a3e for a good example of how the generated code changes.

morki · 2023-11-07T08:28:43Z

@MariusVolkhart oh, thank you for the explanation and sorry for bad understanding. I was probably tired when quickly reviewing.

AlecKazakova · 2023-11-30T16:42:31Z

I think my main concern is how this can leak implementation details of individual drivers. I don't know that all the supported drivers actually return the same thing for each of the mutator queries.

I don't know the right way to solve it. SQLDelight would need some knowledge of how the driver works and choose to return the result if its the thing we want to expose, or run a separate query to get the last_change_id or changes() (in SQLite, IDK what it is for other dialects) so that its guaranteed to behave the same with different drivers

Or we just let them go through as is and its up to the consumer to know what the driver returns, but I don't think thats right

Simple mutators like INSERT, UPDATE, and DELETE, without RETURNING clauses, typically return the number of rows changed. In fact, the SqlDriver#execute() function already does this. However, the value of execute() is not exposed to the generated query files. This commit makes it so that simple INSERT, UPDATE, and DELETE statements return the QueryResult<Long> that the SqlDriver already returns.

MariusVolkhart · 2024-01-07T01:36:41Z

I lean towards the "we just let them go through as is and it's up to the consumer to know what the driver returns" approach.

Firstly, not exposing the return value limits the capabilities of SQLDelight relative to the underlying driver. SqlDriver already has an API that returns the mutated count, and it's a behavior common in many systems (DBMS, JDBC, etc). It feels like quite a severe, yet artificial, limitation compared to Hibernate, JDBC, etc to not expose the ability to query the mutated count.

Secondly, exposing the mutated count means that people can develop custom drivers for implementations (SQLJS, Sqlite) that do query last_change or changes(), if they want that functionality. This assumes that we don't want such functionality built-in, which is reasonable, since a second query that might not be consumed is undesirable.

Thirdly, developers using a driver that doesn't support this will surely either know, or quickly find out when they try to use it, that their driver doesn't support this functionality.

| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [com.github.jsqlparser:jsqlparser](https://github.com/JSQLParser/JSqlParser) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `5.2` -> `5.3` | | [app.cash.sqldelight](https://github.com/sqldelight/sqldelight) | plugin | misk/gradle/libs.versions.toml | gradle | minor | `2.0.2` -> `2.1.0` | | [app.cash.sqldelight:runtime](https://github.com/sqldelight/sqldelight) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.0.2` -> `2.1.0` | | [app.cash.sqldelight:mysql-dialect](https://github.com/sqldelight/sqldelight) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.0.2` -> `2.1.0` | | [app.cash.sqldelight:jdbc-driver](https://github.com/sqldelight/sqldelight) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `2.0.2` -> `2.1.0` | | [software.amazon.awssdk:sdk-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:sqs](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:dynamodb-enhanced](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:dynamodb](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:aws-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:bom](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | | [software.amazon.awssdk:auth](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.44` -> `2.31.45` | --- ### Release Notes <details> <summary>sqldelight/sqldelight (app.cash.sqldelight)</summary> ### [`v2.1.0`](https://github.com/sqldelight/sqldelight/blob/HEAD/CHANGELOG.md#210---2025-05-16) [Compare Source](sqldelight/sqldelight@2.0.2...2.1.0) ##### Added - \[WASM Driver] Add support for wasmJs to web worker driver ([#5534](sqldelight/sqldelight#5534) by \[Ilya Gulya]\[IlyaGulya]) - \[PostgreSQL Dialect] Support PostgreSql UnNest Array to rows ([#5673](sqldelight/sqldelight#5673) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql TSRANGE/TSTZRANGE support ([#5297](sqldelight/sqldelight#5297) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql Right Full Join ([#5086](sqldelight/sqldelight#5086) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Postrgesql extract from temporal types ([#5273](sqldelight/sqldelight#5273) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql array contains operators ([#4933](sqldelight/sqldelight#4933) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql drop constraint ([#5288](sqldelight/sqldelight#5288) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Postgresql type casting ([#5089](sqldelight/sqldelight#5089) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql lateral join operator for subquery ([#5122](sqldelight/sqldelight#5122) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Postgresql ILIKE operator ([#5330](sqldelight/sqldelight#5330) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql XML type ([#5331](sqldelight/sqldelight#5331) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql AT TIME ZONE ([#5243](sqldelight/sqldelight#5243) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Support postgresql order by nulls ([#5199](sqldelight/sqldelight#5199) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Add PostgreSQL current date/time function support ([#5226](sqldelight/sqldelight#5226) by \[Drew Dobson]\[drewd]) - \[PostgreSQL Dialect] PostgreSql Regex operators ([#5137](sqldelight/sqldelight#5137) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] add brin gist ([#5059](sqldelight/sqldelight#5059) by \[Griffio]\[griffio]) - \[MySQL Dialect] Support RENAME INDEX for MySql dialect ([#5212](sqldelight/sqldelight#5212) by \[Oren Kislev]\[orenkislev-faire]) - \[JSON Extension] Add alias to json table function ([#5372](sqldelight/sqldelight#5372) by \[Griffio]\[griffio]) ##### Changed - \[Compiler] Generated query files return row counts for simple mutators ([#4578](sqldelight/sqldelight#4578) by \[Marius Volkhart]\[MariusV]) - \[Native Driver] Update NativeSqlDatabase.kt to change readonly flag for DELETE, INSERT, and UPDATE statements ([#5680](sqldelight/sqldelight#5680) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Change PgInterval to String ([#5403](sqldelight/sqldelight#5403) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Support SqlDelight modules to implement PostgreSql extensions ([#5677](sqldelight/sqldelight#5677) by \[Griffio]\[griffio]) ##### Fixed - \[Compiler] fix: notify queries when executing group statements with result ([#5006](sqldelight/sqldelight#5006) by \[Vitor Hugo Schwaab]\[vitorhugods]) - \[Compiler] Fix SqlDelightModule type resolver ([#5625](sqldelight/sqldelight#5625) by \[Griffio]\[griffio]) - \[Compiler] Fix 5501 insert object escaped column ([#5503](sqldelight/sqldelight#5503) by \[Griffio]\[griffio]) - \[Compiler] Compiler: Improve error message such that path links are clickable with the correct line & char position. ([#5604](sqldelight/sqldelight#5604) by \[Niklas Baudy]\[vanniktech]) - \[Compiler] Fix issue 5298: allow keywords to be used as table names - \[Compiler] fix named executes and add test - \[Compiler] Consider foreign key table constraints when sorting initialization statements ([#5325](sqldelight/sqldelight#5325) by \[Leon Linhart]\[TheMrMilchmann]) - \[Compiler] Align error underlines properly when tabs are involved ([#5224](sqldelight/sqldelight#5224) by \[Drew Dobson]\[drewd]) - \[JDBC Driver] Fix memory leak for connectionManager during end of transaction - \[JDBC Driver] Run SQLite migrations inside transaction as mentioned in documentation ([#5218](sqldelight/sqldelight#5218) by \[Lukáš Moravec]\[morki]) - \[JDBC Driver] Fix leaking connections after transaction commit / rollback ([#5205](sqldelight/sqldelight#5205) by \[Lukáš Moravec]\[morki]) - \[Gradle Plugin] Execute `DriverInitializer` before `GenerateSchemaTask` ([#5562](sqldelight/sqldelight#5562) by \[Emeka Nwagu]\[nwagu]) - \[Runtime] Fix crash in LogSqliteDriver when real driver is Async ([#5723](sqldelight/sqldelight#5723) by \[Eric Denman]\[edenman]) - \[Runtime] Fix StringBuilder capacity ([#5192](sqldelight/sqldelight#5192) by \[Jan Bína]\[janbina]) - \[PostgreSQL Dialect] PostgreSql create or replace view ([#5407](sqldelight/sqldelight#5407) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Postgresql to_json ([#5606](sqldelight/sqldelight#5606) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql numeric resolver ([#5399](sqldelight/sqldelight#5399) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] sqlite windows function ([#2799](sqldelight/sqldelight#2799) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql SELECT DISTINCT ON ([#5345](sqldelight/sqldelight#5345) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] alter table add column if not exists ([#5309](sqldelight/sqldelight#5309) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] Postgresql async bind parameter ([#5313](sqldelight/sqldelight#5313) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql boolean literals ([#5262](sqldelight/sqldelight#5262) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql window functions ([#5155](sqldelight/sqldelight#5155) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql isNull isNotNull types ([#5173](sqldelight/sqldelight#5173) by \[Griffio]\[griffio]) - \[PostgreSQL Dialect] PostgreSql select distinct ([#5172](sqldelight/sqldelight#5172) by \[Griffio]\[griffio]) - \[Paging Extension] paging refresh initial load fix ([#5615](sqldelight/sqldelight#5615) by \[Eva]\[evant]) - \[Paging Extension] Add MacOS native targets ([#5324](sqldelight/sqldelight#5324) by \[Vitor Hugo Schwaab]\[vitorhugods]) - \[IntelliJ Plugin] K2 Support </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: 2c67f3c06e13d86329db5149abfceba98e3701a4

MariusVolkhart force-pushed the mv/mutatorsReturn branch 3 times, most recently from b8054fc to 898868a Compare September 1, 2023 02:29

MariusVolkhart force-pushed the mv/mutatorsReturn branch from 898868a to cf5dea6 Compare November 6, 2023 19:50

MariusVolkhart force-pushed the mv/mutatorsReturn branch from cf5dea6 to 995f65e Compare January 7, 2024 02:03

griffio mentioned this pull request May 6, 2024

DELETES not able to return # rows deleted -- tried changes() and RETURNING COUNT(*) etc #5227

Open

AlecKazakova approved these changes May 13, 2025

View reviewed changes

AlecKazakova and others added 2 commits May 13, 2025 11:23

Merge branch 'master' into mv/mutatorsReturn

3df8e09

Spotless

bae1ca0

AlecKazakova force-pushed the mv/mutatorsReturn branch from 8284b3f to bae1ca0 Compare May 13, 2025 15:47

AlecKazakova and others added 4 commits May 13, 2025 11:55

Merge branch 'master' into mv/mutatorsReturn

b2f2b8b

Merge branch 'master' into mv/mutatorsReturn

02ba0ed

Fix tests

169d4ae

Update integration tests

ce76fe0

AlecKazakova merged commit 9d7f8f3 into sqldelight:master May 13, 2025
11 checks passed

mipastgt mentioned this pull request May 17, 2025

Breaking code changes in 2.1.0 #5750

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Generated query files return row counts for simple mutators #4578

Generated query files return row counts for simple mutators #4578

Uh oh!

MariusVolkhart commented Aug 30, 2023

Uh oh!

morki commented Sep 2, 2023

Uh oh!

morki commented Sep 2, 2023

Uh oh!

MariusVolkhart commented Oct 24, 2023

Uh oh!

morki commented Oct 24, 2023

Uh oh!

MariusVolkhart commented Nov 6, 2023

Uh oh!

morki commented Nov 7, 2023

Uh oh!

AlecKazakova commented Nov 30, 2023

Uh oh!

MariusVolkhart commented Jan 7, 2024

Uh oh!

Uh oh!

Uh oh!

Generated query files return row counts for simple mutators #4578

Generated query files return row counts for simple mutators #4578

Uh oh!

Conversation

MariusVolkhart commented Aug 30, 2023

Review Guide

Uh oh!

morki commented Sep 2, 2023

Uh oh!

morki commented Sep 2, 2023

Uh oh!

MariusVolkhart commented Oct 24, 2023

Uh oh!

morki commented Oct 24, 2023

Uh oh!

MariusVolkhart commented Nov 6, 2023

Uh oh!

morki commented Nov 7, 2023

Uh oh!

AlecKazakova commented Nov 30, 2023

Uh oh!

MariusVolkhart commented Jan 7, 2024

Uh oh!

Uh oh!

Uh oh!