rspec/rules/S5382/apex/rule.adoc

84 lines
2.5 KiB
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
In order to protect shared resources, Salesforce enforces a maximum number of DML statements which can be executed inside a single https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_transaction.htm[transaction]. This is part of https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_gov_limits.htm[Governor limits]. If a DML statement is nested inside a loop's body (For/While/Do-While) it might be executed more times than the Governor limit allows, making the code fail.
Thus it is a best practice to not have DML statements nested in the body of loops and instead perform the DML operation on a list of sObjects.
This rule raises an issue when it detects DML statements inside a loop.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
----
public class myDMLLoop {
public static void myFunction() {
for (Task task: [Select Id, subject from Task]) {
if (task.subject == 'foo') {
task.subject = 'bar';
update task; // Noncompliant
}
}
}
}
// Query in a while loop
public class myDMLLoop {
public static void myFunction(Task[] tasks) {
Integer i = 0;
while ( i < 1000) {
Task task = tasks[i];
if (task.subject == 'foo') {
task.subject = 'bar';
update task; // Noncompliant
}
}
}
}
// Query in a do-while loop
public class myDMLLoop {
public static void myFunction(Task[] tasks) {
Integer i = 0;
do {
Task task = tasks[i];
if (task.subject == 'foo') {
task.subject = 'bar';
update task; // Noncompliant
}
i++;
} while (i < 1000);
}
}
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
----
public class myDMLLoop {
public static void myFunction() {
List<Task> updatedTasks = new List<Task>();
for (Task task: [Select Id, subject from Task]) {
if (task.subject == 'foo') {
task.subject = 'bar';
updatedTasks.add(task);
}
}
update updatedTasks;
}
}
----
2021-04-28 16:49:39 +02:00
== See
* https://developer.salesforce.com/index.php?title=Apex_Code_Best_Practices&oldid=26951[Apex Code Best Practices]
* https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/langCon_apex_loops_for_SOQL.htm[SOQL For Loops]
ifdef::rspecator-view[]
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::rspecator-view[]