Introduction to the SalesforceRestDataProvider Module

The SalesforceRestDataProvider module provides a data provider API for the Salesforce REST API to work with data under the "sobjects" URI path. The SalesforceRestDataProvider class allows for introspecting a Salesforce instance, while the SalesforceRestObjectDataProvider class supports the data provider record-based API for communication with REST servers and querying and manipulating data in the Salesforce instance.

Salesforce instances can be introspected with the following format:

REST operation path: uri_path
- ex: Account
- results in a SalesforceRestObjectDataProvider object where record operations supported on the object can be executed

The following classes are provided by this module:

Salesforce Queries

Queries are made by generating SOQL query strings from the where clause and search options. Note that the Salesforce query API does not currently support server-side result set caching, so the entire result set is returned by the server for each query and stored in memory when using the SalesforceRestRecordIterator class, so it's recommended to limit query result set sizes using the limit search option.

See also

Release Notes

SalesforceRestDataProvider v2.0

added support for the data provider action catalog API (issue 4808)

SalesforceRestDataProvider v1.0.1

fixed a bug deleting records with no matches (issue 3921)
fixed serializing DATE fields (issue 3908)

SalesforceRestDataProvider v1.0

initial release of the module