search

kysely-org / kysely

A type-safe typescript SQL query builder
https://kysely.dev
MIT License
10.46k stars 268 forks source link

Documentation for UpdateResult #988

Closed mjomble closed 3 months ago

mjomble commented 4 months ago

InsertResult is very well documented, with the nuances of different dialects clearly described 👍

UpdateResult, however, contains only two similarly named fields (numUpdatedRows and numChangedRows) with zero comments, which can lead to some confusion 😄

It would be nice to have similarly detailed comments in both. Unfortunately, I don't have enough information to properly document this myself in a PR. I found some info in this issue, but I suspect there's more to it.

Maybe @wirekang, @igalklebanov or @koskimas would be up for it? Or you could post the necessary information in this thread, which I could then prepare into a PR.

wirekang commented 4 months ago

Comments on QueryResult will be enough information to make a PR. Good luck. https://github.com/kysely-org/kysely/blob/deea8e22aae3dc4e142f055b6ec4d9a50a402bda/src/driver/database-connection.ts#L23-L35