Search code examples
paginationsalesforcesoql

SOQL Pagination for Salesforce API queries

Is there an efficient way to page through results from a SOQL query without bringing all the query results back and then discarding the majority of them?

As an example, I'd like to be able to to page through the complete list of contacts showing 10 records at a time. I don't have the need to sort by any particular field.

Solution

  • Currently the most efficient solution I've found that will work with any SOQL query through the partner API is to persist the sObjects returned from the initial QueryResult and the query locator incase a page is requested outside the current results.

    This required a level of paging support on top of the Salesforce QueryResult.

    I.e. When a page is requested sObjects may be required from:

    • The current (cached) QueryResult
    • A subsequent QueryResult that can be fetched using the query locator
    • A prior QueryResult
    • Some combination of all three.

    If the page spans two (or more) QueryResults an artifical QueryResult will need to be created with all the required records.

    Update for Spring 2012 Release

    Looks like there is new functionality coming that will add OFFSET support to SOQL. E.g.

    SELECT Name FROM Merchandise__c WHERE Price__c > 5.0 ORDER BY Name LIMIT 50 OFFSET 100

    See Spring '12 Force.com Platform Release - OFFSET added to SOQL (Pilot)

    Update for Summer 2012 Release

    OFFSET is now GA (General Availability?)