Class KyselyTransactionImpl<DBSchema>

Represents a transaction in a Postgres database.

Type Parameters

DBSchema

Hierarchy (view full)

DatabaseTransaction
- KyselyTransactionImpl

Properties

`Protected`_isOpen

_isOpen: boolean

A boolean flag indicating whether a certain feature is open or closed.

arguments

arguments: any

caller

caller: Function

`Protected`database

database: Database<KyselyTransaction<DBSchema>>

A protected property representing a database instance.

`Readonly`length

length: number

`Readonly`name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype

prototype: any

`Readonly`reader

reader: Kysely<any>

A readonly property representing a reader of type Kysely. This property allows reading data of any type using the Kysely interface.

`Protected`transaction

transaction: Transaction<any>

A protected property representing a transaction of type any.

`Readonly`writer

writer: Kysely<any>

A readonly property representing a writer for a Kysely object.

Methods

[hasInstance]

[hasInstance](value): boolean
Determines whether the given value inherits from this function if this function was used as a constructor function.

A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.
Parameters
- value: any
Returns boolean
Inherited from DatabaseTransaction.[hasInstance]
- Defined in ../../../../../root/.npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:164

apply

apply(this, thisArg, argArray?): any
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Parameters
- this: Function
- thisArg: any
  The object to be used as the this object.
- OptionalargArray: any
  A set of arguments to be passed to the function.
Returns any
Inherited from DatabaseTransaction.apply
- Defined in ../../../../../root/.npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es5.d.ts:281

begin

begin(): Promise<void>
Begins a transaction asynchronously.

Returns Promise<void>
A Promise that resolves when the transaction has begun.

Throws
If the transaction is already open.
Inherited from DatabaseTransaction.begin
- Defined in src/Database/DatabaseTransaction.ts:90

bind

bind(this, thisArg, ...argArray): any
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters
- this: Function
- thisArg: any
  An object to which the this keyword can refer inside the new function.
- Rest...argArray: any[]
  A list of arguments to be passed to the new function.
Returns any
Inherited from DatabaseTransaction.bind
- Defined in ../../../../../root/.npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es5.d.ts:296

call

call(this, thisArg, ...argArray): any
Calls a method of an object, substituting another object for the current object.
Parameters
- this: Function
- thisArg: any
  The object to be used as the current object.
- Rest...argArray: any[]
  A list of arguments to be passed to the method.
Returns any
Inherited from DatabaseTransaction.call
- Defined in ../../../../../root/.npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es5.d.ts:288

closeFailure

closeFailure(): Promise<void>
Closes the failure by performing a rollback if the failure is currently open.

Returns Promise<void>
A promise that resolves once the rollback is completed.
Inherited from DatabaseTransaction.closeFailure
- Defined in src/Database/DatabaseTransaction.ts:146

closeSuccess

closeSuccess(): Promise<void>
Closes the success modal, committing or rolling back changes based on the autoCommit setting. If the modal is open and autoCommit is enabled, it will commit the changes. If autoCommit is disabled, it will rollback the changes.

Returns Promise<void>
A promise that resolves once the commit or rollback operation is completed.
Inherited from DatabaseTransaction.closeSuccess
- Defined in src/Database/DatabaseTransaction.ts:132

commit

commit(): Promise<void>
Asynchronously commits the transaction. If the transaction is already closed, an error is thrown.

Returns Promise<void>
Promise

Throws
Error if the transaction is already closed
Inherited from DatabaseTransaction.commit
- Defined in src/Database/DatabaseTransaction.ts:104

`Protected`doBegin

doBegin(): Promise<unknown>
Asynchronously begins a transaction using a writer and resolves the transaction once it is executed.

Returns Promise<unknown>
A Promise that resolves with the transaction object once the transaction is executed.
Overrides DatabaseTransaction.doBegin
- Defined in src/Database/integrations/kysely/KyselyTransaction.ts:77

`Protected`doCommit

doCommit(): Promise<void>
Executes the commit operation by resolving the transaction wrapper and returning a resolved Promise.

Returns Promise<void>
A Promise that resolves to null.
Overrides DatabaseTransaction.doCommit
- Defined in src/Database/integrations/kysely/KyselyTransaction.ts:97

`Protected`doRollback

doRollback(): Promise<void>
Performs a rollback operation by rejecting the transaction wrapper with an error.

Returns Promise<void>
A resolved Promise after the rollback operation is completed.
Overrides DatabaseTransaction.doRollback
- Defined in src/Database/integrations/kysely/KyselyTransaction.ts:106

isOpen

isOpen(): boolean
Check if the object is open.

Returns boolean
- true if the object is open, false otherwise.
Inherited from DatabaseTransaction.isOpen
- Defined in src/Database/DatabaseTransaction.ts:81

rollback

rollback(): Promise<void>
Rollback the transaction by reverting any changes made within the transaction. If the transaction is already closed, an error is thrown.

Returns Promise<void>
Promise

Throws
Error if the transaction is already closed.
Inherited from DatabaseTransaction.rollback
- Defined in src/Database/DatabaseTransaction.ts:118

toString

toString(): string
Returns a string representation of a function.

Returns string
Inherited from DatabaseTransaction.toString
- Defined in ../../../../../root/.npm/_npx/dafcb7cdaad6ed61/node_modules/typescript/lib/lib.es5.d.ts:299

`Static`newTransaction

newTransaction<DBSchema>(connection, database, reader?): Promise<KyselyTransaction<DBSchema>>
Creates a new database transaction for the given database schema.
Type Parameters
- DBSchema
Parameters
- connection: Kysely<DBSchema>
  The connection object for the transaction.
- database: KyselyDatabase<DBSchema>
  The database object for the transaction.
- Optionalreader: Kysely<DBSchema>
  An optional reader object for the transaction.
Returns Promise<KyselyTransaction<DBSchema>>
A promise that resolves to the created transaction.
- Defined in src/Database/integrations/kysely/KyselyTransaction.ts:63

`Protected` `Static`proxyInstance

proxyInstance<T>(subclass): T
Creates a proxy instance for the given subclass of DatabaseTransaction. The proxy handles method binding and transaction execution based on the subclass state.
Type Parameters
- T extends DatabaseTransaction
Parameters
- subclass: T
  The subclass of DatabaseTransaction to proxy.
Returns T
A proxied instance of the subclass with method binding and transaction execution logic.
Inherited from DatabaseTransaction.proxyInstance
- Defined in src/Database/DatabaseTransaction.ts:55

Class KyselyTransactionImpl<DBSchema>

Type Parameters

Hierarchy (view full)

Index

Properties

Methods

Properties

Protected_isOpen

arguments

caller

Protecteddatabase

Readonlylength

Readonlyname

prototype

Readonlyreader

Protectedtransaction

Readonlywriter

Methods

[hasInstance]

Parameters

Returns boolean

apply

Parameters

Returns any

begin

Returns Promise<void>

Throws

bind

Parameters

Returns any

call

Parameters

Returns any

closeFailure

Returns Promise<void>

closeSuccess

Returns Promise<void>

commit

Returns Promise<void>

Throws

ProtecteddoBegin

Returns Promise<unknown>

ProtecteddoCommit

Returns Promise<void>

ProtecteddoRollback

Returns Promise<void>

isOpen

Returns boolean

rollback

Returns Promise<void>

Throws

toString

Returns string

StaticnewTransaction

Type Parameters

Parameters

Returns Promise<KyselyTransaction<DBSchema>>

Protected StaticproxyInstance

Type Parameters

Parameters

Returns T

Settings

On This Page

`Protected`_isOpen

`Protected`database

`Readonly`length

`Readonly`name

`Readonly`reader

`Protected`transaction

`Readonly`writer

`Protected`doBegin

`Protected`doCommit

`Protected`doRollback

`Static`newTransaction

`Protected` `Static`proxyInstance