XA_END

The XA_END function is used to dissociate the current session from the transaction branch specified by xid.

The transaction manager calls XA_END when the control thread completes or needs to pause the transaction on the transaction branch. This is typically done when the application has partially or fully completed its work, such as before blocking an event to allow other control threads to work on the branch. After XA_END returns successfully, the control thread is no longer effectively associated with the branch, but the branch still exists.

Syntax

DBMS_XA.XA_END (
   xid   IN  DBMS_XA_XID,
   flag  IN  PLS_INTEGER)
RETURN PLS_INTEGER;

Parameters

Return value

For more information, see Possible constant return values of DBMS_XA.

Possible error codes: XAER_RMERR, XAER_RMFAILED, XAER_NOTA, XAER_INVAL, XAER_PROTO, or XA_RB\*.

Considerations

• You can specify TMSUCCESS or TMSUSPEND in flag. If the return value is XA_OK, the transaction branch is dissociated from the current session. TMFAIL is not supported. You can call XA_END with TMSUCCESS or TMSUSPEND to dissociate the transaction branch identified by xid from the current session.

• If XA_END is executed successfully, it returns XA_OK. The application must check the return value and handle any errors. The application should only proceed with other normal operations if XA_OK is returned.

• Executing the ROLLBACK statement before calling XA_END will roll back the changes made by the current transaction. However, the transaction context is still associated with the current session before XA_END is called.

• Executing the COMMIT statement before calling XA_END will result in the error OBE-02089: COMMIT is not allowed in a subordinate session.

• Executing the COMMIT or ROLLBACK statement after XA_END has no effect on the transaction identified by xid, as it is no longer associated with the current session. To commit or rollback the transaction specified by xid, use the transaction ID or the XA_ROLLBACK function.