search.PagedData

Note:

The content in this help topic pertains to SuiteScript 2.0.

Object Description

Holds metadata for a paginated query.

This object provides a high-level view of a search result, giving the total count of records, a list of pages ranges, and page size. For paged searches, the maximum number of result rows per page is 1000. The minimum number of result rows per page is 5, except for the last page in the result set (because the last page may include fewer than 5 results).

For a complete list of this object’s methods and properties, see PagedData Object Members.

Important:

Search result sets are not cached. If records applicable to your search are created, modified, or deleted at the same time you are traversing your result set, your result set may change.

Supported Script Types

Client and server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/search Module

Since

Version 2015 Release 1

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/search Module Script Samples.

          //Add additional code 
...
// Run the paged search
var pagedData = mySearch.runPaged({
    pageSize: 1000
});
...
// Use the count property to count the
// search results easily
var resultCount = mySearch.runPaged({
    pageSize: 1000
}).count;
...
//Add additional code

Syntax

Related Topics