Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Batchable Interface
BatchableContext Interface
Cursor Class (Beta)
DeletedRecord Class
DeleteFilter Enum
DeleteResult Class
DMLOptions Class
DmlOptions.AssignmentRuleHeader Class
DMLOptions.DuplicateRuleHeader Class
DmlOptions.EmailHeader Class
DuplicateError Class
EmptyRecycleBinResult Class
Error Class
GetDeletedResult Class
GetUpdatedResult Class
LeadConvert Class
LeadConvertResult Class
MergeResult Class
QueryLocator Class
QueryLocator Methods
QueryLocatorIterator Class
SaveResult Class
UndeleteResult Class
UpsertResult Class
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

QueryLocator Class

Represents the record set returned by Database.getQueryLocator and used with Batch Apex.

Namespace

Database

QueryLocator Methods

The following are methods for QueryLocator. All are instance methods.

getQuery()

Returns the query used to instantiate the Database.QueryLocator object. This is useful when testing the start method.

Signature

public String getQuery()

Return Value

Type: String

Usage

You can’t use the FOR UPDATE keywords with a getQueryLocator query to lock a set of records. The set of records in the batch is determined when the start method is run.

Example

System.assertEquals(QLReturnedFromStart.
getQuery(),
Database.getQueryLocator([SELECT Id
   FROM Account]).getQuery() );

iterator()

Returns a new instance of a query locator iterator.

Signature

public Database.QueryLocatorIterator iterator()

Return Value

Type: Database.QueryLocatorIterator

Usage

To iterate over a query locator, save the iterator instance that this method returns in a variable and then use this variable to iterate over the collection. Calling iterator every time you want to perform an iteration can result in incorrect behavior because each call returns a new iterator instance.

Warning

For an example, see QueryLocatorIterator Class.