Apex Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Spring '14 (API version 30.0)
Actions
Chatter Answers and Ideas
Moderate Chatter Private Messages with Triggers
Communities
External IDs for Lightning Connect External Objects
Callouts for Lightning Connect Custom Adapters
Paging with the Apex Connector Framework
Aggregation for Lightning Connect Custom Adapters
Considerations for the Apex Connector Framework
Support Classes
Territory Management 2.0
Glossary
Newer Version Available
Key Concepts About the Apex Connector Framework
The DataSource namespace provides the classes for the Apex Connector Framework.
Use the Apex Connector Framework to develop a custom adapter for Lightning Connect.
Then connect your Salesforce organization to any
data anywhere via the Lightning Connect custom adapter.
We recommend that you learn about some key concepts to help you use the Apex Connector Framework effectively.
-
External IDs for Lightning Connect External Objects
When you access external data with a custom adapter for Lightning Connect, the values of the External ID standard field on an external object come from the DataSource.Column named ExternalId. -
Callouts for Lightning Connect Custom Adapters
Just like any other Apex code, a Lightning Connect custom adapter can make callouts. If the connection to the external system requires authentication, incorporate the authentication parameters into the callout. -
Paging with the Apex Connector Framework
When displaying a large set of records in the user interface, Salesforce breaks the set into batches and displays one batch. You can then page through those batches. However, custom adapters for Lightning Connect don’t automatically support paging of any kind. To support paging through external object data that’s obtained by a custom adapter, implement server-driven or client-driven paging. -
queryMore with the Apex Connector Framework
Custom adapters for Lightning Connect don’t automatically support the queryMore method in API queries. However, your implementation must be able to break up large result sets into batches and iterate over them by using the queryMore method in the SOAP API. The default batch size is 500 records, but the query developer can adjust that value programmatically in the query call. -
Aggregation for Lightning Connect Custom Adapters
If you receive a COUNT() query, the selected column has the value QueryAggregation.COUNT in its aggregation property. The selected column is provided in the columnsSelected property on the tableSelection for the DataSource.QueryContext. -
Filters in the Apex Connector Framework
The DataSource.QueryContext contains one DataSource.TableSelection. The DataSource.SearchContext can have more than one TableSelection. Each TableSelection has a filter property that represents the WHERE clause in a SOQL or SOSL query.