MarkLogic 10 Product Documentationdls.documentCheckin
dls.documentCheckin( uri as String, deep as Boolean ) as null
Summary
This function checks in (unlocks) the document at the
specified URI to allow other users to modify the document. This function
does not create a new version of the document. You must explicitly use
dls.documentUpdate
to create new versions of a document.
dls.documentCheckout
and
dls.documentUpdate
functions.
| Parameters | |
|---|---|
| uri | The URI of the document. |
| deep | If set to true,
then any documents directly or indirectly included by the specified document
are also checked in. |
Required Privileges
Thedls-user role is required to run
this function, or the privilege:http://marklogic.com/xdmp/privileges/dls-user
Example
// Checks in 'baz.xml' and all of its included documents.
const dls = require('/MarkLogic/dls');
declareUpdate();
dls.documentCheckin('/foo/bar/baz.xml', true);