MarkLogic 12 EA 2 Product Documentation

AccessPlan.prototype.offsetLimit

AccessPlan.prototype.offsetLimit(
   start as String,
   length as String
) as ModifyPlan

Summary

This method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit.

A common pattern is to page over a result set by using a op.param placeholder parameter for the start and specifying the starting value in bindings for prototype.result. This approach reuses the cached query instead of recalculating the query on each request.

Usage Notes

limit is a method of the following classes:

• AccessPlan
• ModifyPlan

Example

// Calculate the total expenses for each employee and return two results in order
// of employee number, starting with the third result.

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

const employees = op.fromView('main', 'employees');
const expenses = op.fromView('main', 'expenses');
const totalexpenses  = op.col('totalexpenses');
const Plan =
employees.joinInner(expenses, op.on(employees.col('EmployeeID'), expenses.col('EmployeeID')))
   .groupBy(employees.col('EmployeeID'), ['FirstName', 'LastName', expenses.col('Category'),
    op.sum(totalexpenses, expenses.col('Amount'))])
   .orderBy('EmployeeID')
   .offsetLimit(2, 2)
Plan.result();