Skip to content

Commit

Permalink
jsdocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
igalklebanov committed Oct 4, 2024
1 parent 75eaebf commit e67f9bc
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/kysely.ts
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,12 @@ export class Kysely<DB>
* The {@link ControlledTransactionBuilder.execute} method can then be called
* to start the transaction and return a {@link ControlledTransaction}.
*
* A {@link ControlledTransaction} allows you to commit and rollback manually, execute savepoint commands. It extends {@link Transaction} which extends {@link Kysely}, so you can run queries inside the transaction.
* A {@link ControlledTransaction} allows you to commit and rollback manually,
* execute savepoint commands. It extends {@link Transaction} which extends {@link Kysely},
* so you can run queries inside the transaction. Once the transaction is committed,
* or rolled back, it can't be used anymore - all queries will throw an error.
* This is to prevent accidentally running queries outside the transaction - where
* atomicity is not guaranteed anymore.
*
* ### Examples
*
Expand Down

0 comments on commit e67f9bc

Please sign in to comment.