Adds Bulk API notes. #717
Open
Adds Bulk API notes. #717
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
mattmartin26
reviewed
May 9, 2024
docs/user_guide/bulk_api_notes.rst
Outdated
| Exception Code "InvalidBatch" with message "Records not processed" | ||
| ================================================================== | ||
|
|
||
| When processing your Bulk API request, one of the first chings Salesforce does is to check the schema of your payload. If the schema is not correct, you will get an error message with the exception code "InvalidBatch" and the message "Records not processed". |
mattmartin26
approved these changes
May 9, 2024
docs/user_guide/bulk_api_notes.rst
Outdated
|
|
||
| my_dataframe['Account__r'] = my_dataframe['Account__r'].apply(lambda x: {'AccountNumber': x}) | ||
|
|
||
| This will convert the `Account__r` column to a dictionary with the external id field that you are using to look up the Account object. This is because of the way relationships work in Salesforce. If you are somewhat familiar with how the platform's database works, you will notice that for the row that is going to be inserted the column that references the lookup object is transformed to an object, in a similar way that in Apex you use the relationship field to access the fields of the related object. This works for standard objects as well, where instead of *ContactId* you would use just *Contact*. |
There was a problem hiding this comment.
Finding this sentence just a bit unclear. Unsure how to suggest an improvement but for someone unexperienced in Apex its hard to envision what being 'transformed to an object' means.
There was a problem hiding this comment.
I made some changes to this PR so that the spelling is fixed and this part is a little better explained.
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.
I thought of adding these Bulk API notes to help anyone who might be struggling a bit with the
sf.bulk.methods of the library. In this text I write about a common error ("InvalidBatch") and how to check the data before sending it over to Salesforce, and also add some tips on preparing the data's date/time columns and relationship fields.