Skip to content

QRY_Builder.QueryPage ​

Class · Group: Query Infrastructure

Learn it: Fast Start - Selectors and Selectors guide

apex
global class QRY_Builder.QueryPage

Result container for paged queries, providing records and pagination metadata.


Properties ​

PropertyDescription
global Boolean hasMorePagesTrue if there are more pages after the current page.
global Boolean hasPriorPagesTrue if there are pages before the current page.
global Integer totalPagesTotal number of pages available.

hasMorePages ​

apex
global Boolean hasMorePages

Type: Boolean

True if there are more pages after the current page.

hasPriorPages ​

apex
global Boolean hasPriorPages

Type: Boolean

True if there are pages before the current page.

totalPages ​

apex
global Integer totalPages

Type: Integer

Total number of pages available.

Fields ​

FieldDescription
global Database.PaginationCursor cursorThe PaginationCursor, which a Lightning web component can send back to the server to read the next page.
global Integer deletedRecordsNumber of records deleted since the cursor was created.
global Integer pageNumberThe current page number (1-based).
global Integer pageSizeNumber of records per page.
global List<SObject> recordsThe records for the requested page.
global Integer totalRecordsTotal number of records matching the query criteria.

cursor ​

apex
global Database.PaginationCursor cursor

Type: Database.PaginationCursor

The PaginationCursor, which a Lightning web component can send back to the server to read the next page. Passing it back keeps the pages stable across requests.

It is null whenever the page was read without a pagination cursor. That happens when more records match than the paging allowance left in the transaction, or when the transaction has no pagination cursors left. The allowance is 100,000 records today, and every paged read in the same transaction uses it, so a later read has only what the earlier ones left. Such pages are read another way: records, totalRecords and every paging flag stay correct. Only deletedRecords is not available, so it reads 0. Check for null before passing the cursor back.

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Database.PaginationCursor cursor = page.cursor;

deletedRecords ​

apex
global Integer deletedRecords

Type: Integer

Number of records deleted since the cursor was created. Useful for detecting data changes between page fetches.

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer deleted = page.deletedRecords;

pageNumber ​

apex
global Integer pageNumber

Type: Integer

The current page number (1-based).

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(2, 25);
Integer currentPage = page.pageNumber; // 2

pageSize ​

apex
global Integer pageSize

Type: Integer

Number of records per page.

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer size = page.pageSize; // 25

records ​

apex
global List<SObject> records

Type: List

The records for the requested page.

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
List<SObject> pageRecords = page.records;

totalRecords ​

apex
global Integer totalRecords

Type: Integer

Total number of records matching the query criteria.

Example

apex
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
    .getPage(1, 25);
Integer total = page.totalRecords;