KernDX

Appearance

DML_Builder ​

Class · Group: DML

apex
global inherited sharing class DML_Builder

Fluent DML API for building and executing database operations. Uses a static factory entry point to create a transaction context, fluent methods to register operations and configure behaviour, and a terminal method to commit all operations via DML_Transaction.

Since: 1.0

Example:

apex
DML_Builder.TransactionResult result = DML_Builder.newTransaction()
    .doInsert(account)
    .doInsert(contact, Contact.AccountId, account)
    .doUpdate(existingRecord)
    .allowPartial()
    .execute();

See Also: DML_Transaction

Properties ​

PropertyDescription
global enum DatabaseOperationEnum to specify the type of DML operation for external use.

Methods ​

MethodDescription
global DML_Builder allowPartial()Enables partial success mode.
global DML_Builder.DML_AsyncBuilder async()Switches to asynchronous execution mode.
global DML_Builder bypassSharing()Bypasses sharing rules for DML operations.
global DML_Builder doDelete(List<SObject> records)Registers multiple records for deletion.
global DML_Builder doDelete(SObject record)Registers a single record for deletion.
global DML_Builder doInsert(List<SObject> records)Registers multiple records for insertion.
global DML_Builder doInsert(SObject record)Registers a single record for insertion.
global DML_Builder doInsert(SObject child, SObject relationshipField, SObject parent)Registers a child record for insertion with a relationship to a parent record.
global DML_Builder doUndelete(List<SObject> records)Registers multiple records for undelete.
global DML_Builder doUndelete(SObject record)Registers a single record for undelete.
global DML_Builder doUpdate(List<SObject> records)Registers multiple records for update.
global DML_Builder doUpdate(SObject record)Registers a single record for update.
global DML_Builder doUpsert(List<SObject> records)Registers multiple records for upsert.
global DML_Builder doUpsert(List<SObject> records, SObject externalIdField)Registers multiple records for upsert with a specific external ID field.
global DML_Builder doUpsert(SObject record)Registers a single record for upsert.
global DML_Builder doUpsert(SObject record, SObject externalIdField)Registers a single record for upsert with a specific external ID field.
global DML_Builder.TransactionResult execute()Commits all registered DML operations via DML_Transaction and returns the result.
global static DML_Builder newTransaction()Creates a new DML_Builder instance representing a DML transaction.
global DML_Builder suppressExceptions()Suppresses DmlException re-throw in all-or-nothing mode.
global DML_Builder suppressLogging()Suppresses LOG_Builder error logging for DML failures.
global DML_Builder withSystemMode()Forces AccessLevel.SYSTEM_MODE on every DML operation in this transaction.
global DML_Builder withUserMode()Forces AccessLevel.USER_MODE on every DML operation in this transaction, regardless of the UserModeDml_Enabled feature flag.

Inner Classes ​

ClassDescription
DML_AsyncBuilderAsync DML execution wrapper.
TransactionResultResult object returned by execute() containing the outcome of all DML operations in the transaction.

Method Details ​

allowPartial ​

apex
global DML_Builder allowPartial()

Enables partial success mode. Failed records do not cause the entire transaction to fail.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(records)
    .allowPartial()
    .execute();

async ​

apex
global DML_Builder.DML_AsyncBuilder async()

Switches to asynchronous execution mode. Returns a DML_AsyncBuilder that delegates to PROC_ExecuteDML and UTIL_AsynchronousJobLauncher for adaptive async processing.

Returns: DML_Builder.DML_AsyncBuilder - A DML_AsyncBuilder for configuring and executing async DML.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(records)
    .allowPartial()
    .async()
    .execute();

bypassSharing ​

apex
global DML_Builder bypassSharing()

Bypasses sharing rules for DML operations.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(records)
    .bypassSharing()
    .execute();

doDelete ​

apex
global DML_Builder doDelete(List<SObject> records)

Registers multiple records for deletion.

Parameters:

  • records (List) - The list of SObjects to delete.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doDelete(records)
    .execute();

doDelete ​

apex
global DML_Builder doDelete(SObject record)

Registers a single record for deletion.

Parameters:

  • record (SObject) - The SObject to delete.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doDelete(record)
    .execute();

doInsert ​

apex
global DML_Builder doInsert(List<SObject> records)

Registers multiple records for insertion.

Parameters:

  • records (List) - The list of SObjects to insert.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(accounts)
    .execute();

doInsert ​

apex
global DML_Builder doInsert(SObject record)

Registers a single record for insertion.

Parameters:

  • record (SObject) - The SObject to insert.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(new Account(Name = 'Test'))
    .execute();

doInsert ​

apex
global DML_Builder doInsert(SObject child, SObjectField relationshipField, SObject parent)

Registers a child record for insertion with a relationship to a parent record.

Parameters:

  • child (SObject) - The child SObject to insert.
  • relationshipField (SObjectField) - The field linking the child to the parent.
  • parent (SObject) - The parent SObject.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(account)
    .doInsert(contact, Contact.AccountId, account)
    .execute();

doUndelete ​

apex
global DML_Builder doUndelete(List<SObject> records)

Registers multiple records for undelete.

Parameters:

  • records (List) - The list of SObjects to undelete.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUndelete(records)
    .execute();

doUndelete ​

apex
global DML_Builder doUndelete(SObject record)

Registers a single record for undelete.

Parameters:

  • record (SObject) - The SObject to undelete.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUndelete(record)
    .execute();

doUpdate ​

apex
global DML_Builder doUpdate(List<SObject> records)

Registers multiple records for update.

Parameters:

  • records (List) - The list of SObjects to update.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(accounts)
    .execute();

doUpdate ​

apex
global DML_Builder doUpdate(SObject record)

Registers a single record for update.

Parameters:

  • record (SObject) - The SObject to update.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(account)
    .execute();

doUpsert ​

apex
global DML_Builder doUpsert(List<SObject> records)

Registers multiple records for upsert.

Parameters:

  • records (List) - The list of SObjects to upsert.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpsert(accounts)
    .execute();

doUpsert ​

apex
global DML_Builder doUpsert(List<SObject> records, SObjectField externalIdField)

Registers multiple records for upsert with a specific external ID field.

Parameters:

  • records (List) - The list of SObjects to upsert.
  • externalIdField (SObject) - The external ID field for matching.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpsert(accounts, Account.ExternalId__c)
    .execute();

doUpsert ​

apex
global DML_Builder doUpsert(SObject record)

Registers a single record for upsert.

Parameters:

  • record (SObject) - The SObject to upsert.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpsert(account)
    .execute();

doUpsert ​

apex
global DML_Builder doUpsert(SObject record, SObjectField externalIdField)

Registers a single record for upsert with a specific external ID field.

Parameters:

  • record (SObject) - The SObject to upsert.
  • externalIdField (SObjectField) - The external ID field for matching.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpsert(account, Account.ExternalId__c)
    .execute();

execute ​

apex
global DML_Builder.TransactionResult execute()

Commits all registered DML operations via DML_Transaction and returns the result.

Returns: DML_Builder.TransactionResult - A TransactionResult containing the outcome of all DML operations.

Since: 1.0

Example:

apex
DML_Builder.TransactionResult result = DML_Builder.newTransaction()
    .doInsert(account)
    .doInsert(contact, Contact.AccountId, account)
    .execute();

newTransaction ​

apex
global static DML_Builder newTransaction()

Creates a new DML_Builder instance representing a DML transaction.

Returns: DML_Builder - A new DML_Builder instance.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(account)
    .execute();

suppressExceptions ​

apex
global DML_Builder suppressExceptions()

Suppresses DmlException re-throw in all-or-nothing mode. Errors are logged via LOG_Builder instead of propagating to the caller.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(record)
    .suppressExceptions()
    .execute();

suppressLogging ​

apex
global DML_Builder suppressLogging()

Suppresses LOG_Builder error logging for DML failures.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doUpdate(records)
    .allowPartial()
    .suppressLogging()
    .execute();

withSystemMode ​

apex
global DML_Builder withSystemMode()

Forces AccessLevel.SYSTEM_MODE on every DML operation in this transaction. Use when the framework writes objects the running user has no FLS/CRUD on by design (logs, orchestration records, framework-owned sObjects).

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(logEntryEvent)
    .withSystemMode()
    .execute();

withUserMode ​

apex
global DML_Builder withUserMode()

Forces AccessLevel.USER_MODE on every DML operation in this transaction, regardless of the UserModeDml_Enabled feature flag. Use when a subscriber-facing flow must enforce CRUD/FLS even in orgs where the flag has been disabled as a kill-switch.

Returns: DML_Builder - This builder instance for fluent chaining.

Since: 1.0

Example:

apex
DML_Builder.newTransaction()
    .doInsert(accountFromSubscriberUI)
    .withUserMode()
    .execute();