Class SpriteTransaction

A transaction in Sprite, contains the transaction id, and methods to commit or rollback the transaction.

Param: session

the DatabaseSession the transaction is taking place of

Param: transactionId

the id of the transaction

Index

Constructors

Accessors

committed id rolledBack

Methods

commit crud rollback

Constructors

constructor

new SpriteTransaction(session, transactionId): SpriteTransaction
Parameters
- session: DatabaseSession
- transactionId: string
Returns SpriteTransaction
- Defined in src/transaction/SpriteTransaction.ts:17

Accessors

committed

get committed(): boolean
Whether or not the transaction has been committed

Returns boolean
- Defined in src/transaction/SpriteTransaction.ts:30

id

get id(): string
The trasaction ID

Returns string
- Defined in src/transaction/SpriteTransaction.ts:22

rolledBack

get rolledBack(): boolean
Whether or not the transaction has been rolledback

Returns boolean
- Defined in src/transaction/SpriteTransaction.ts:26

Methods

commit

commit(): Promise<boolean>
Commit the transaction.

Returns Promise<boolean>
true if the transaction was commited.
- Defined in src/transaction/SpriteTransaction.ts:37

crud

crud<T>(language, command, parameters?): Promise<T>
Perform a CRUD operation in the transaction.
Type Parameters
- T
Parameters
- language: ArcadeSupportedQueryLanguages
  the query language to use
- command: string
  the command to execute
- Optionalparameters: Record<string, string | number | boolean>
Returns Promise<T>
the result of the CRUD operation
- Defined in src/transaction/SpriteTransaction.ts:56

rollback

rollback(): Promise<boolean>
Rollback the transaction.

Returns Promise<boolean>
true if the transaction was commited.
- Defined in src/transaction/SpriteTransaction.ts:45