MarkLogic Server 11.0 Product Documentation
xdmp.xaForget

xdmp.xaForget(
   forestID as (Number|String),
   txn-id as (Number|String)
) as null

Summary

Forgets a remembered completed XA transaction.

Parameters
forestID The forest ID of the coordinating forest.
txn-id The ID of a MarkLogic transaction that is part of a global XA transaction.

Required Privileges

http://marklogic.com/xdmp/privileges/xa-forget

Usage Notes

Once a global transaction is prepared, it is remembered only by the coordinating forest. Supply the coordinating forest's ID to this function. Use xdmp:host-status and xdmp:forest-status to discover the coordinating forest.

Example

xdmp.xaForget(forest-id, txn-id);

=> Empty. The given transaction is forgotten and can no longer
   be recovered.
Powered by MarkLogic Server | Terms of Use | Privacy Policy