airflow.providers.salesforce.operators.bulk¶

Classes¶

SalesforceBulkOperator

Execute a Salesforce Bulk API and pushes results to xcom.

Module Contents¶

class airflow.providers.salesforce.operators.bulk.SalesforceBulkOperator(*, operation, object_name, payload, external_id_field='Id', batch_size=10000, use_serial=False, salesforce_conn_id='salesforce_default', **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Execute a Salesforce Bulk API and pushes results to xcom.

See also

For more information on how to use this operator, take a look at the guide: SalesforceBulkOperator

Parameters:

operation (typing_extensions.Literal[insert, update, upsert, delete, hard_delete]) – Bulk operation to be performed Available operations are in [‘insert’, ‘update’, ‘upsert’, ‘delete’, ‘hard_delete’]
object_name (str) – The name of the Salesforce object
payload (list) – list of dict to be passed as a batch
external_id_field (str) – unique identifier field for upsert operations
batch_size (int) – number of records to assign for each batch in the job
use_serial (bool) – Process batches in serial mode
salesforce_conn_id (str) – The Salesforce Connection id.

available_operations = ('insert', 'update', 'upsert', 'delete', 'hard_delete')[source]¶

operation[source]¶

object_name[source]¶

payload[source]¶

external_id_field = 'Id'[source]¶

batch_size = 10000[source]¶

use_serial = False[source]¶

salesforce_conn_id = 'salesforce_default'[source]¶

execute(context)[source]¶

Make an HTTP request to Salesforce Bulk API.

Parameters:: context (airflow.sdk.definitions.context.Context) – The task context during execution.
Returns:: API response if do_xcom_push is True