On this page
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Use 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.
Support and Limitations
Works in Ultra Pipelines.
...
Input/Output | 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. |
Snap Settings
Parameter Name | Data Type | Description |
---|
Label* | 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. Default Value: Salesforce Bulk Query |
Example: Salesforce Bulk Query | |
Service version* | String |
---|
Specify the Salesforce Bulk Query service version that you want to use for this query. Default Value: 47.0 | |
SOQL query* | 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.
Default value: Default Value: [None] | |||||||
Max records per set* | Integer |
---|
Specify the number of records that you want the Snap to fetch in a single set. Default Value: 10000 | |
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 Maximum value: 60 Default Value: 5 | |
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 Value: 3000 | |
Maximum retry attempts | Integer |
---|
Specify the maximum number of retry attempts that the Snap must make in case of a network failure. Minimum value: 1
Default Value: 5 | ||||||
Retry interval (seconds) | Integer |
---|
Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure. Minimum value: 0 Default Value: 1 | |
Snap Execution | String |
---|
Select one of the three modes in which the Snap executes. Available options are:
|
|
|
|
|
Default |
Value: Validate & Execute |
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
...