Loading TOC...

dls.breakCheckout

dls.breakCheckout(
   $uri as String,
   $deep as Boolean
) as null

Summary

This function breaks (unlocks) a checked-out document

Parameters
$uri The URI of the checked out document.
$deep If set to true, then the checkout is broken for any checked-out documents that are directly or indirectly included by the specified document.

Required Privileges

The dls-admin role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-admin

Example

// This breaks the checkout of the 'sample.xml' document.
   
const dls = require('/MarkLogic/dls');
  
declareUpdate();
dls.breakCheckout('/foo/bar/baz.xml', true);
   

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.