Loading TOC...

dls.nodeExpand

dls.nodeExpand(
   $node as Node,
   $restriction as cts.query?
) as Node

Summary

This function recursively examines the node for XInclude references and expands them, following the rules of the XInclude specification. The result is a node in which all the XInclude references have been resolved, or an error if there were unresolvable references with no fallback specifications. The URIs are mapped according to the specified restrictions.

Parameters
$node The node to be expanded.
$restriction Restriction that control which documents may be considered for inclusion. An exact URI match is first considered if it matches the specified restrictions, followed by the most recent numbered version of that URI that matches the restrictions.

Required Privileges

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

Usage Notes

This function cannot expand root node documents that contain XInclude links to specific versioned documents. You must use xinc:node-expand to expand such documents.

Example

  // Returns the contents of the 'baz.xml' document version that was created 
  // before the specified date, along with all of its referenced nodes.

const dls = require('/MarkLogic/dls');

let node = cts.doc('/foo/bar/baz.xml');

 dls.nodeExpand(
               node, 
               dls.asOfQuery(xs.dateTime('2009-04-06T09:39:33.576-07:00')));
   

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