Change Data Capture Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Change Data Capture
Keep Your External Data Current with Change Data Capture
Change Event Message Structure
Merged Change Events
Other Types of Change Events: Gap and Overflow Events
Subscribe to Change Events
Monitor Change Event Publishing and Delivery Usage
Security Considerations
Change Event Considerations
Standard Object Notes
Change Events for Fields
Sending Data Differences for Fields of Updated Records
Data Differences in Event Fields
How to Reconstruct a Field from Its Diff Value
Considerations for Newline Characters and Computing the SHA-256 Hash
Change Events for Custom Field Type Conversions
PDF

Sending Data Differences for Fields of Updated Records

To reduce the event payload size and improve performance, Salesforce sometimes sends data differences of updated text values. For large text fields, such as Description or Long Text Area fields that contain at least 1,000 characters, only the data differences might be sent. Data differences use the unified diff format.

Differences are computed for each line in the text value. The diff algorithm breaks the field value into lines by using the line breaks found in the value.

If sending the diff for updates of large text fields does not reduce the field size, the entire value is sent. The diff value is not sent for the following conditions.

  • The length of the field value is less than 1,000 characters.
  • The difference between the old and new values is greater than 50% in length.
  • More than 25% of the lines of the total of number of lines in the old and new values are changed.
  • The diff’s length is greater than the length of the new value.

For more information about the unified diff format and the diff utility, see the Diff Utility Wikipedia article.

The diff value includes an SHA-256 hash value that is computed on the entire updated value. Use the hash value to verify that the reconstructed value matches the original value before it was converted to a diff. To do so, compute the SHA-256 hash after expanding the diff value. Then compare the two hash values to ensure that they’re equal. If the reconstructed content is different from the original content, the hash value is different. To compute an SHA-256 hash value, you can use a utility such as the UNIX sha256sum command or the DigestUtils class from the Apache Commons library.