Class TrmUserTransaction

The TrmUserTransaction class has methods that allows an application to create transaction boundaries, such as for begin, commit, or roll back. A Node.js application must create an instance of this class and use the instance methods for transaction demarcation.

Hierarchy

  • TrmUserTransaction

Constructors

constructor

Methods

begin commit execute getStatus getTransactionID getTransactionTimeout getTransactionUrl resume rollback setRollbackOnly setTransactionTimeout suspend

Constructors

constructor

  • Intialize a user transaction

    Parameters

    • Optional gtrid: string

      global transaction id

    • Optional timeout: number

      transaction timeout value in milliseconds

    Returns TrmUserTransaction

Methods

begin

  • Starts a new user transaction

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      Express request object

    • Optional enlist: boolean

      true, if current request needs to enlist in the transaction

    Returns Promise<void>

commit

  • Commits the transaction

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      Express request object

    Returns Promise<void>

execute

  • Executes a transaction

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      Express request object

    • func: Function

      The function to execute as part of the transaction

    • Rest ...args: any[]

      The arguments to pass to the func mentioned

    Returns Promise<unknown>

getStatus

  • Obtain the status of the transaction. If no transaction is started, this method returns the 0 value

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      Express request object

    Returns Promise<number>

getTransactionID

  • Get the GTRID of the transaction

    Returns string

    the GTRID of the transaction

getTransactionTimeout

  • Get timeout in milliseconds

    Returns number

    timeout in milliseconds

getTransactionUrl

  • Get the transaction URL

    Returns string

    the transaction URL

resume

  • Resumes the transaction

    Returns void

rollback

  • Abort the transaction immediately, so that all pending changes are discarded.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      Express request object

    Returns Promise<void>

setRollbackOnly

  • Modify the state of the current transaction. So that a rollback is the only possible outcome, but do not perform the rollback yet

    Returns void

setTransactionTimeout

  • Modifies the timeout value in seconds that is associated with the transaction started with the begin method. If the transaction is not began, this methods throws an error If an application has not called this method, the transaction service uses a default value for the transaction timeout

    Parameters

    • timeout: number

      timeout in milliseconds

    Returns void

suspend

  • Suspends the transaction

    Returns void

Settings

Member Visibility

Theme

On This Page

Copyright © 2022, 2025, Oracle and/or its affiliates.