XA_START

The XA_START function associates the current session with the transaction branch specified by xid.

Syntax

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

Parameters

Return value

See DBMS_XA possible constant return values.

Considerations

• If the TMJOIN or TMRESUME flag is specified in the flag, the existing transaction branch identified by xid is started. When you want to separate a transaction by using the TMSUCCESS flag, use the TMJOIN flag. When you want to separate a transaction branch by using the TMSUSPEND flag, use the TMRESUME flag. You can use either flag to call the XA_START function to join an existing transaction branch.

• If the TMNOFLAGS flag is specified in the flag and the TMJOIN and TMRESUME flags are not specified, a new transaction branch is started. If a transaction branch is specified by xid, the XA_START function returns the XAER_DUPID error code.

• Possible error return values include: XAER_RMERR, XAER_RMFAIL, XAER_DUPID, XAER_OUTSIDE, XAER_NOTA, XAER_INVAL, and XAER_PROTO.

• If the XA_START function is executed successfully, it returns XA_OK. The application must check the return value and handle errors. The PL application should only continue with other operations after XA_OK is returned. Transaction stacks are not supported. If an active transaction is associated with the current session, the transaction may not be called to start or join another transaction. If you call the XA_START function by using an active global transaction branch associated with the current session, the XAER_PROTO error code is returned. If you call the XA_START function by using a local transaction associated with the current session, the XAER_OUTSIDE error code is returned.