Docs: Add clarity on per-stream resets and formula fields in Salesforce (#33233)
Co-authored-by: nataliekwong <nataliekwong@users.noreply.github.com> Co-authored-by: Augustin <augustin@airbyte.io>
This commit is contained in:
Natalie Kwong
@@ -81,18 +81,10 @@ To obtain these credentials, follow [this walkthrough](https://medium.com/@bpmme
|
||||
|
||||
The Salesforce source connector supports the following sync modes:
|
||||
|
||||
- (Recommended)[ Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped)
|
||||
- [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
|
||||
- [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
|
||||
- [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
|
||||
- (Recommended)[ Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped)
|
||||
|
||||
### Incremental Deletes sync
|
||||
|
||||
The Salesforce connector supports retrieving deleted records from the Salesforce recycle bin. For the streams which support it, a deleted record will be marked with `isDeleted=true`. To find out more about how Salesforce manages records in the recycle bin, please visit their [docs](https://help.salesforce.com/s/articleView?id=sf.home_delete.htm&type=5).
|
||||
|
||||
## Performance considerations
|
||||
|
||||
The Salesforce connector is restricted by Salesforce’s [Daily Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the [Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped) sync mode.
|
||||
|
||||
## Supported Objects
|
||||
|
||||
@@ -103,12 +95,26 @@ Airbyte allows exporting all available Salesforce objects dynamically based on:
|
||||
- If the authenticated Salesforce user has the Role and Permissions to read and fetch objects
|
||||
- If the salesforce object has the queryable property set to true. Airbyte can only fetch objects which are queryable. If you don’t see an object available via Airbyte, and it is queryable, check if it is API-accessible to the Salesforce user you authenticated with.
|
||||
|
||||
### A note on the BULK API vs REST API and their limitations
|
||||
## Syncing Formula Fields
|
||||
|
||||
The Salesforce connector syncs formula field outputs from Salesforce. If the formula of a field changes in Salesforce and no other field on the record is updated, you will need to reset the stream and sync a historical backfill to pull in all the updated values of the field.
|
||||
|
||||
## Syncing Deletes
|
||||
|
||||
The Salesforce connector supports retrieving deleted records from the Salesforce recycle bin. For the streams which support it, a deleted record will be marked with `isDeleted=true`. To find out more about how Salesforce manages records in the recycle bin, please visit their [docs](https://help.salesforce.com/s/articleView?id=sf.home_delete.htm&type=5).
|
||||
|
||||
|
||||
## Performance considerations
|
||||
|
||||
The Salesforce connector is restricted by Salesforce’s [Daily Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the [Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped) sync mode.
|
||||
|
||||
|
||||
## Usage of the BULK API vs REST API
|
||||
|
||||
Salesforce allows extracting data using either the [BULK API](https://developer.salesforce.com/docs/atlas.en-us.236.0.api_asynch.meta/api_asynch/asynch_api_intro.htm) or [REST API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). To achieve fast performance, Salesforce recommends using the BULK API for extracting larger amounts of data (more than 2,000 records). For this reason, the Salesforce connector uses the BULK API by default to extract any Salesforce objects, unless any of the following conditions are met:
|
||||
|
||||
- The Salesforce object has columns which are unsupported by the BULK API, like columns with a `base64` or `complexvalue` type
|
||||
- The Salesforce object is not supported by BULK API. In this case we sync the objects via the REST API which will occasionalyl cost more of your API quota. This list of objects was obtained experimentally, and includes the following objects:
|
||||
- The Salesforce object is not supported by BULK API. In this case we sync the objects via the REST API which will occasionally cost more of your API quota. This includes the following objects:
|
||||
- AcceptedEventRelation
|
||||
- Attachment
|
||||
- CaseStatus
|
||||
@@ -133,9 +139,7 @@ Salesforce allows extracting data using either the [BULK API](https://developer.
|
||||
More information on the differences between various Salesforce APIs can be found [here](https://help.salesforce.com/s/articleView?id=sf.integrate_what_is_api.htm&type=5).
|
||||
|
||||
:::info Force Using Bulk API
|
||||
|
||||
If you set the `Force Use Bulk API` option to `true`, the connector will ignore unsupported properties and sync Stream using BULK API.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user