Docs: Updates Salesforce Source Connector Docs (Removes inapp page, adds <HideInUI>, adds Limitations & Troubleshooting) #32371
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…itations & Troubleshooting section. Added env and HideInUI tags for dynamically rendering content.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
octavia-squidington-iii
added
the
area/documentation
katmarkham
requested changes
Nov 10, 2023
| @@ -132,20 +166,28 @@ 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 | |||
| :::note Force Using Bulk API | |||
There was a problem hiding this comment.
this is rendering weirdly
There was a problem hiding this comment.
this is rendering weirdly
@katmarkham Is this happening via Docusaurus or in the markdown preview in GitHub? These are Docusaurus admonitions so I don't think they'll render in GitHub markdown.
This is what I see when running Docusaurus locally:
katmarkham
requested changes
Nov 22, 2023
|
|
||
| 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 occasionalyl cost more of your API quota. This list of objects was obtained experimentally, and includes the following objects: |
There was a problem hiding this comment.
Thanks for the catch. Updated.
katmarkham
approved these changes
Nov 29, 2023
jatinyadav-cc
pushed a commit
to ollionorg/datapipes-airbyte
that referenced
this pull request
Feb 26, 2024
…dds <HideInUI>, adds Limitations & Troubleshooting) (airbytehq#32371)
jatinyadav-cc
pushed a commit
to ollionorg/datapipes-airbyte
that referenced
this pull request
Feb 26, 2024
…dds <HideInUI>, adds Limitations & Troubleshooting) (airbytehq#32371)
jatinyadav-cc
pushed a commit
to ollionorg/datapipes-airbyte
that referenced
this pull request
Feb 26, 2024
…dds <HideInUI>, adds Limitations & Troubleshooting) (airbytehq#32371)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Updates for Salesforce source connector docs pages. This update includes addition of new collapsible troubleshooting section, as well as the replacement of the "inapp" docs with the new tags per Issue #32069.
How
in-apppageHideInUItags to all sections other thanPrerequisitesandSetup Guide.envtags handle sections to be displayed only in OSS vs Cloud pages.Main page vs In-app OSS (Example)
Limitations & Troubleshooting Section (Example)