QueryBatch
Gets data from Salesforce using query batch. Only batches created in CSV format are supported. Note that the outputs of this stored procedure are dynamic and depend on the Query input.
Input
| Name | Type | Description |
| Query | String | The query to be executed using the BULK API. It can either be a SQL query or SOQL query depending on the QueryMode input. Query parameter is required if job id and batch id are not specified. |
| QueryMode | String | Indicates the nature of the query to be executed. If it is a SQL query, it will be processed client-side in case of unsupported elements. In case of SOQL query it will directly be sent to Salesforce as is. Note that SOQL query does not support the following: COUNT, ROLLUP, SUM, GROUP BY CUBE, OFFSET, Nested SOQL queries, Relationship fields. Also, Bulk API cannot access or query compound address or compound geolocation fields. Columns name should be used instead of wildcard (*) in SOQL mode because it is not supported.
The allowed values are SQL, SOQL. The default value is SOQL. |
| JobId | String | The id of the job. If this parameter is specified, batch id should be specified too. |
| BatchId | String | The id of the batch. If this parameter is specified, job id should be specified too. |
| ChunkSize | String | Salesforce recommends that you enable chunking when querying tables with more than 10 million records or when a bulk query consistently times out. If chunksize is specified the query, result will be splited into multiple batches. Set the value equal to 0 to disable spliting the result into chunks. The maximum size of the chunk cannot be more than 250000
The default value is 30000. |
| ConcurrencyMode | String | The concurrency mode for the job. The valid values are Parallel or Serial. Parallel: Process batches in parallel mode which is the default value. Serial: Process batches in serial mode. Processing in parallel can cause database contention. When this is severe, the job may fail. If you experience this issue, submit the job with serial concurrency mode. This guarantees that batches are processed one at a time. Note that using this option may significantly increase the processing time for a job.
The allowed values are Parallel, Serial. The default value is Parallel. |
| SkipErrors | String | This boolean parameter indicates if the provider should skip failed batches and get results for completed batches.
The allowed values are true, false. The default value is false. |
| Rows@Next | String | This is used to page through multiple pages of results and should not be set manually. |
Result Set Columns
| Name | Type | Description |
| QueryJobId | String | The Id of the job. |
| QueryBatchId | String | The Id of the batch. |