MarkLogic 9 Product DocumentationPreparePlan.prototype.explain
PreparePlan.prototype.explain( format 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 json (default)
or xml.
|
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();