Skip to content

Commit

Permalink
improve insertId API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
koskimas committed Sep 9, 2023
1 parent fef3525 commit 3e35d9d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/query-builder/insert-result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,14 @@
*/
export class InsertResult {
/**
* The auto incrementing primary key
* The auto incrementing primary key of the inserted row.
*
* This property can be undefined when the query contains an `on conflict`
* clause that makes the query succeed even when nothing gets inserted.
*
* This property is always undefined on dialects like PostgreSQL that
* don't return the inserted id by default. On those dialects you need
* to use the {@link ReturningInterface.returning | returning} method.
*/
readonly insertId: bigint | undefined

Expand Down

1 comment on commit 3e35d9d

@vercel
Copy link

@vercel vercel bot commented on 3e35d9d Sep 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

kysely – ./

kysely-git-master-kysely-team.vercel.app
www.kysely.dev
kysely-kysely-team.vercel.app
kysely.dev

Please sign in to comment.