Publish

Publish platform events.

Example

Account account = new Account(Name = 'New Account');
MyEvent__e event = new MyEvent__e(Message__c = 'Account Created');

new DML()
    .toInsert(account)
    .toPublish(event)
    .commitWork();

toPublish

Register platform events for publishing. The actual publish is executed when commitWork() is called.

Signature

Committable toPublish(SObject record);
Committable toPublish(List<SObject> records);

Single Event

Signature

Committable toPublish(SObject record);

Standard DML

MyEvent__e event = new MyEvent__e(Message__c = 'Hello World');
EventBus.publish(event);

DML Lib

MyEvent__e event = new MyEvent__e(Message__c = 'Hello World');

new DML()
    .toPublish(event)
    .commitWork();

Multiple Events

Signature

Committable toPublish(List<SObject> records);

Standard DML

List<MyEvent__e> events = new List<MyEvent__e>{
    new MyEvent__e(Message__c = 'Event 1'),
    new MyEvent__e(Message__c = 'Event 2'),
    new MyEvent__e(Message__c = 'Event 3')
};
EventBus.publish(events);

DML Lib

List<MyEvent__e> events = new List<MyEvent__e>{
    new MyEvent__e(Message__c = 'Event 1'),
    new MyEvent__e(Message__c = 'Event 2'),
    new MyEvent__e(Message__c = 'Event 3')
};

new DML()
    .toPublish(events)
    .commitWork();

Combined with DML Operations

Combine event publishing with other DML operations.

Standard DML

Account account = new Account(Name = 'New Account');
insert account;

AccountCreatedEvent__e event = new AccountCreatedEvent__e(
    AccountName__c = 'New Account'
);
EventBus.publish(event);

DML Lib

Account account = new Account(Name = 'New Account');
AccountCreatedEvent__e event = new AccountCreatedEvent__e(
    AccountName__c = 'New Account'
);

new DML()
    .toInsert(account)
    .toPublish(event)
    .commitWork();

WARNING

Platform events are published asynchronously. Even if the DML transaction is rolled back, published events may still be delivered.

publishImmediately

Publish platform events immediately and return the operation result without calling commitWork().

Signature

OperationResult publishImmediately(SObject record);
OperationResult publishImmediately(List<SObject> records);

TIP

All DML settings configured on the DML instance (such as allowPartialSuccess()) are inherited when executing publishImmediately.

Single Event

Signature

OperationResult publishImmediately(SObject record);

Standard DML

MyEvent__e event = new MyEvent__e(Message__c = 'Hello World');
Database.SaveResult result = EventBus.publish(event);

DML Lib

MyEvent__e event = new MyEvent__e(Message__c = 'Hello World');
DML.OperationResult result = new DML().publishImmediately(event);

Multiple Events

Signature

OperationResult publishImmediately(List<SObject> records);

Standard DML

List<MyEvent__e> events = new List<MyEvent__e>{
    new MyEvent__e(Message__c = 'Event 1'),
    new MyEvent__e(Message__c = 'Event 2')
};
List<Database.SaveResult> results = EventBus.publish(events);

DML Lib

List<MyEvent__e> events = new List<MyEvent__e>{
    new MyEvent__e(Message__c = 'Event 1'),
    new MyEvent__e(Message__c = 'Event 2')
};
DML.OperationResult result = new DML().publishImmediately(events);