QRY_Builder.QueryPage
Class · Group: Query Infrastructure
Learn it: Fast Start - Selectors and Selectors guide
global class QRY_Builder.QueryPageResult container for paged queries, providing records and pagination metadata.
Properties
| Property | Description |
|---|---|
| global Boolean hasMorePages | True if there are more pages after the current page. |
| global Boolean hasPriorPages | True if there are pages before the current page. |
| global Integer totalPages | Total number of pages available. |
hasMorePages
global Boolean hasMorePagesType: Boolean
True if there are more pages after the current page.
hasPriorPages
global Boolean hasPriorPagesType: Boolean
True if there are pages before the current page.
totalPages
global Integer totalPagesType: Integer
Total number of pages available.
Fields
| Field | Description |
|---|---|
| global Database.PaginationCursor cursor | The PaginationCursor, which a Lightning web component can send back to the server to read the next page. |
| global Integer deletedRecords | Number of records deleted since the cursor was created. |
| global Integer pageNumber | The current page number (1-based). |
| global Integer pageSize | Number of records per page. |
| global List<SObject> records | The records for the requested page. |
| global Integer totalRecords | Total number of records matching the query criteria. |
cursor
global Database.PaginationCursor cursorType: 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
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(1, 25);
Database.PaginationCursor cursor = page.cursor;deletedRecords
global Integer deletedRecordsType: Integer
Number of records deleted since the cursor was created. Useful for detecting data changes between page fetches.
Example
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(1, 25);
Integer deleted = page.deletedRecords;pageNumber
global Integer pageNumberType: Integer
The current page number (1-based).
Example
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(2, 25);
Integer currentPage = page.pageNumber; // 2pageSize
global Integer pageSizeType: Integer
Number of records per page.
Example
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(1, 25);
Integer size = page.pageSize; // 25records
global List<SObject> recordsType: List
The records for the requested page.
Example
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(1, 25);
List<SObject> pageRecords = page.records;totalRecords
global Integer totalRecordsType: Integer
Total number of records matching the query criteria.
Example
QRY_Builder.QueryPage page = QRY_Builder.selectFrom(Account.SObjectType)
.getPage(1, 25);
Integer total = page.totalRecords;