On this page
Table of Contents | ||||
---|---|---|---|---|
|
...
You can use this Snap to perform bulk SOQL queries using Salesforce Bulk API 2.0.
Prerequisites
Valid Salesforce OAuth 2 account with Read permissions.
...
View Type | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description | |||
---|---|---|---|---|---|---|---|
Input | Document |
|
| A document containing values required for the bulk query. | |||
Output | Document |
|
| A document containing the results of the query performed by the Snap. | |||
Error | Document |
| N/A | The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error PipelineError handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
Snap Settings
Field | Field Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Label* DefaultValue:Salesforce Bulk Query | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. | |||||||||
Service Version* Default Value: | Salesforce Bulk QueryService Version*52.0 | Salesforce Bulk Query41.0 | String/Expression/Suggestion | Specify the version number associated with the Salesforce service that you want to connect to. Alternatively, click the Suggestion icon to fetch the list of versions and select the desired version. | |||||||
SOQL Query* DefaultValue: 52.0 | SOQL Query*None
| String | Specify the query in SOQL format. You can enter a JavaScript expression, which is evaluated each time the Snap is executed. As in the second example below, on each document received from the input view, the % symbols will be replaced with the value pointed to by the JSON path $.Id in the input data. "SELECT Name FROM Account" "SELECT Id,Name,Phone FROM Account WHERE Id='" + $Id + "'and Name='" + $name + "'"
| ||||||||
Max Records Per Set* Default Value: [None]10000 "select FirstName, LastName from " + $object + " order by Name LIMIT 5" | Max Records Per Set*5000 | Integer | Specify the number of records that you want the Snap to fetch in a single set. | ||||||||
Default Polling Interval* Default Value: 100005 | Polling Interval* | Integer | Specify the number of seconds for which you want the Snap to wait between two queries. At each polling interval, the Snap checks the status of the Bulk API query batch processing. Minimum value: 1 | ||||||||
Polling Timeout* Default Default Value: 53000 | Polling Timeout* | Integer | Specify the number of seconds into the query batch execution before the query fails if it receives no response. If the timeout occurs while waiting for the completion of the query batch execution, the Snap throws a SnapExecutionException. Minimum value: 10 Default | ||||||||
Maximum Retry Attempts Default Value: 30005 Example: 300 | Maximum Retry Attempts1 | Integer | Specify the maximum number of retry attempts that the Snap must make in case of a network failure. Minimum value: 1
| ||||||||
Include Deleted Records Default Value: Deselected | Checkbox | Select this checkbox to include deleted records in the query result. This feature is supported in Bulk API version 47.0 or later. | |||||||||
Match Data Type Default Value: Deselected | Checkbox | Select this checkbox to match the data types of the bulk query job results. On selecting this checkbox, the Snap converts string values to the corresponding data types if the original data type is one of Boolean, Integer, Double, Currency, and Percent.
| |||||||||
Object Type
| String/Expression | Appears on selecting the Match Data Type checkbox. Specify the object type to match. Alternatively, select an object type from the suggestions list to match the data type. | |||||||||
Retry Interval (seconds) Default Value:1 | Integer | Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure. Minimum value: 0 | |||||||||
Snap Execution DefaultValue: 1Validate & Execute | Snap Execution | Execute only | String | Select one of the three modes in which the Snap executes. Available options are:
Example: Execute only |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Multiexcerpt include macro name Temporary Files page Join
Examples
Querying for Contacts in Salesforce Using Upstream Parameters in the Bulk Query Snap
...