Skip to content

SOQLRecipes

pozil edited this page Nov 14, 2024 · 19 revisions

SOQLRecipes Class

Demonstrates how to make various types of SOQL calls including multi-object queries, and aggregate queries

Group Data Recipes

Methods

getRecords()

Demonstrates the proper way to query accounts with SOQL keeping FLS and CRUD in account.

Signature

public static List<Account> getRecords()

Return Type

List<Account>

Example

List<Account> results = SOQLRecipes.querySingleObject();
System.debug(results);

getLargeNumberOfRecords()

Demonstrates how to loop over a SOQL query

Signature

public static Integer getLargeNumberOfRecords()

Return Type

Integer

Example

System.debug(SOQLRecipes.getLargeNumberOfRecords());

getChunksOfLargeNumbersOfRecords()

One of the little known features of SOQL for loops is that you can iterate not only over each record returned by the query, but also over each chunk of records. As the code below demonstrates, specifying the iteration variable as a list/array will return 200 record chunks from the query, rather than individual records.

Note: Normally, if you're only dealing with counts of records, you'd utilize the Count() soql method, but in this case we're demonstrating that this form of a soql for loop gives you access both to a list of records, and to the records themselves.

Signature

public static Integer getChunksOfLargeNumbersOfRecords()

Return Type

Integer


getRecordsByFieldValue()

Demonstrates how to use a WHERE clause in a SOQL query

Signature

public static List<Account> getRecordsByFieldValue()

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getRecordsByFieldValue());

getRecordsByMultipleFieldValues()

Demonstrates how to use a complex WHERE clause in a SOQL query

Signature

public static List<Account> getRecordsByMultipleFieldValues()

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getRecordsByMultipleFieldValues());

getSpecificNumberOfRecords()

Demonstrates how to use the LIMIT clause in a SOQL statement

Signature

public static List<Account> getSpecificNumberOfRecords()

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getSpecificNumberOfRecords());

getFirstXRecords(wantedNumberOfRows)

Demonstrates how to use a bound variable to define the LIMIT

Signature

public static List<Account> getFirstXRecords(Integer wantedNumberOfRows)

Parameters

Name Type Description
wantedNumberOfRows Integer the number of rows desired

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getFirstXRecords(5));

getAccountRecordsInState(state)

Demonstrates how to use a bound variable in a WHERE clause

Signature

public static List<Account> getAccountRecordsInState(String state)

Parameters

Name Type Description
state String String representing a US State code (AK, KS, etc.)

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getAccountRecordsInState('ks'));

getSecond10AccountRecords()

Demonstrates how to get a limited number of results with a given offset; Ie: get the second set of 10 records.

Signature

public static List<Account> getSecond10AccountRecords()

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getSecond10AccountRecords());

getRecordsWithRelatedRecords()

Demonstrates how to query an object, as well as it's related child objects

Signature

public static List<Account> getRecordsWithRelatedRecords()

Return Type

List<Account>

Example

System.debug(SOQLRecipes.getRecordsWithRelatedRecords());

getParentRecordDetailsFromChildRecord()

Demonstrates how to query fields from a parent object through the relationship field

Signature

public static List<Contact> getParentRecordDetailsFromChildRecord()

Return Type

List<Contact>

Example

System.debug(SOQLRecipes.getParentRecordDetailsFromChildRecord());

getDetailsFromBothParentRecords()

Demonstrates how to write a query that pulls information from two parent objects through a junction object

Signature

public static List<Junction__c> getDetailsFromBothParentRecords()

Return Type

List<Junction__c>

Example

System.debug(SOQLRecipes.getDetailsFromBothParentRecords());

getSumOfOpportunityRecords(accountId)

demonstrates how to use aggregate methods, like Sum() or Count() in a SOQL query. This example generates the sum of opportunities associated with a specified Account

Signature

public static Double getSumOfOpportunityRecords(Id accountId)

Parameters

Name Type Description
accountId Id an AccountId

Return Type

Double

Example

Id accountId = [SELECT Id FROM Account LIMIT 1].Id;
System.debug(SOQLRecipes.getSumOfOpportunityRecords(accountId));
Clone this wiki locally