MarkLogic 12 Product Documentation
IteratePlan.prototype.explain

IteratePlan.prototype.explain(
   [format as String],
   [options as String[]]
) as Plan

Summary

This method returns a representation of the builtin execution plan.

Parameters
format	The format of the returned plan, expressed as a lower-case string. This can be either `xml` (default) or `json`.
options	Options as an array of string values. Available options are: "optimize=N" Sets the optimization level to use. Levels of 0 (off), 1, and 2 are recognized. The default is 1. "seed=N" Sets the seed to use. The default will generate a random seed. Setting it to 0 will behave the same as the default case. The default is 0.

Usage Notes

explain is a method of the following classes:

Example

const op = require('/MarkLogic/optic');

op.fromView('main', 'employees')
   .select(['EmployeeID', 'FirstName', 'LastName'])
   .orderBy('EmployeeID')
   .explain();

Example

const op = require('/MarkLogic/optic');

op.fromView('main', 'employees')
   .select(['EmployeeID', 'FirstName', 'LastName'])
   .orderBy('EmployeeID')
   .explain('json', ['seed=0','optimize=1']);

MarkLogic 12 Product DocumentationIteratePlan.prototype.explain

Summary

Usage Notes

Example

Example

MarkLogic 12 Product Documentation
IteratePlan.prototype.explain