Bulk API Properties
- Last Updated: April 19, 2021
- 1 minute read
- DataDirect Connectors
- JDBC
- Salesforce 6.0
- Documentation
The following table summarizes connection properties that are used to implement the Salesforce Bulk API for selects, inserts, updates, and deletes.
| Property | Description |
|---|---|
| BulkFetchThreshold | Specifies a number of rows that, if exceeded, signals the
driver to use the Salesforce Bulk API for select operations. For
this behavior to take effect, the EnableBulkFetch property must be
set to true.If
set to If set to The default is |
| BulkLoadAsync | Determines whether the driver treats bulk load operations
as synchronous or asynchronous. If set to If set to The default is |
| BulkLoadBatchSize | Provides a suggestion to the driver for the number of rows
to load to the database at a time when bulk loading data. The
default is |
| BulkLoadConcurrencyMode | Determines whether multiple batches associated with a
bulk load operation are processed by Salesforce in parallel or one
at a time. If set to If set to
The default is |
| BulkLoadJobSize | Determines the number of rows to load into a single job
of a bulk operation when the connection property BulkLoadVersion is
set to V2. Performance can be improved by increasing the number of
rows the driver loads at a time because fewer network round trips
are required. Increasing the number of rows also causes the driver
to consume more memory on the client. The default
is |
| BulkLoadPollInterval | Specifies the number of seconds the driver waits to
request bulk operation status. This interval is used by the driver
the first time it requests status and for all subsequent status
requests. The default is |
| BulkLoadThreshold | Specifies a number of rows that, if exceeded, signals the
driver to use the Salesforce Bulk API for inserts, updates, and
deletes. For this behavior to take effect, the EnableBulkLoad
property must be set to true.If set to If set to The default is |
| BulkLoadVersion |
Specifies which version of Salesforce Bulk Load API to use for
performing bulk load operations. This is applicable if
EnableBulkLoad is set to If set to If set to The default is |
| EnableBulkFetch | Specifies whether the driver can use the Salesforce Bulk
API for selects based on the value of the BulkFetchThreshold
connection property. If the number of rows expected in the result
set exceeds the value of BulkFetchThreshold property, the driver
uses the Salesforce Bulk API to execute the select operation. Using
the Salesforce Bulk API may significantly reduce the number of Web
service calls used to execute a statement and, therefore, may
improve performance. If set to If
set to The default is
|
| EnableBulkLoad | Specifies whether the driver can use the Salesforce Bulk
API for inserts, updates, and deletes based on the value of the
BulkLoadThreshold connection property. If the number of affected
rows exceeds the value of BulkLoadThreshold property, the driver
uses the Salesforce Bulk API to execute the insert, update, or
delete operation. Using the Salesforce Bulk API may significantly
reduce the number of Web service calls used to execute a statement
and, therefore, may improve performance. If set
to If set to The default is |
| EnablePKChunking | Specifies whether the driver uses PK chunking for select
operations. PK chunking breaks down bulk fetch operations into
smaller, more manageable batches for improved performance. If set to If set
to The
default is |
| PKChunkSize | Specifies the size, in rows, of a
primary key chunk when PK chunking has been enabled via the
EnablePKChunking property. The Salesforce Bulk API splits the query
into chunks of this size. PKChunkSize may be set
to a maximum value of The default is |