PagedData Object Members in SuiteScript 2.0

The PagedData object in SuiteScript 2.0 is essential for developers managing paged query results, providing a comprehensive set of methods and properties to streamline data retrieval.

What is the PagedData Object?

The PagedData object encapsulates a set of paged query results, allowing developers to work with extensive datasets effectively. This object can be created using the Query.runPaged(options) or Query.runPaged.promise(options) methods. Each call can return up to 1000 results per page, streamlining the handling of large data results in NetSuite.

What Are PagedData Object Members?

The PagedData object includes various methods and properties designed for efficient data manipulation. Below is a summary of these members:

Methods

Properties

Example Usage

To use the PagedData object effectively, you can set up a paginated query as follows:

1var myCustomerQuery = query.create({
2    type: query.Type.CUSTOMER
3});
4myCustomerQuery.columns = [
5    myCustomerQuery.createColumn({ fieldId: 'entityid' }),
6    myCustomerQuery.createColumn({ fieldId: 'firstname' }),
7    myCustomerQuery.createColumn({ fieldId: 'email' })
8];
9var myPagedResults = myCustomerQuery.runPaged({ pageSize: 10 });
10 
11// Fetch results using an iterator
12var iterator = myPagedResults.iterator();
13iterator.each(function(resultPage) {
14    var currentPage = resultPage.value;
15    var currentPagedData = currentPage.pagedData;
16    log.debug(currentPage.pageRange.size);
17    return true;
18});

In this example, a customer query is defined, executed, and results are iterated using the iterator() method of the PagedData object.

Who This Affects

This information is crucial for:

• Developers: Who need to handle paged data efficiently in their scripts.
• Administrators: Overseeing data management processes that involve paged queries.

Key Takeaways

• The PagedData object is vital for managing large datasets in SuiteScript 2.0.
• It includes methods for synchronous and asynchronous data retrieval.
• The object supports read-only properties for understanding query results.

Source: This article is based on Oracle's official NetSuite documentation.