Source code for airflow.providers.salesforce.operators.bulk

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from typing import TYPE_CHECKING, Iterable, cast

from airflow.models import BaseOperator
from airflow.providers.salesforce.hooks.salesforce import SalesforceHook

if TYPE_CHECKING:
    from simple_salesforce.bulk import SFBulkHandler
    from typing_extensions import Literal

    from airflow.utils.context import Context


[docs]class SalesforceBulkOperator(BaseOperator): """ Execute a Salesforce Bulk API and pushes results to xcom. .. seealso:: For more information on how to use this operator, take a look at the guide: :ref:`howto/operator:SalesforceBulkOperator` :param operation: Bulk operation to be performed Available operations are in ['insert', 'update', 'upsert', 'delete', 'hard_delete'] :param object_name: The name of the Salesforce object :param payload: list of dict to be passed as a batch :param external_id_field: unique identifier field for upsert operations :param batch_size: number of records to assign for each batch in the job :param use_serial: Process batches in serial mode :param salesforce_conn_id: The :ref:`Salesforce Connection id <howto/connection:SalesforceHook>`. """
[docs] available_operations = ("insert", "update", "upsert", "delete", "hard_delete")
def __init__( self, *, operation: Literal["insert", "update", "upsert", "delete", "hard_delete"], object_name: str, payload: list, external_id_field: str = "Id", batch_size: int = 10000, use_serial: bool = False, salesforce_conn_id: str = "salesforce_default", **kwargs, ) -> None: super().__init__(**kwargs) self.operation = operation self.object_name = object_name self.payload = payload self.external_id_field = external_id_field self.batch_size = batch_size self.use_serial = use_serial self.salesforce_conn_id = salesforce_conn_id self._validate_inputs() def _validate_inputs(self) -> None: if not self.object_name: raise ValueError("The required parameter 'object_name' cannot have an empty value.") if self.operation not in self.available_operations: raise ValueError( f"Operation {self.operation!r} not found! " f"Available operations are {self.available_operations}." )
[docs] def execute(self, context: Context): """ Make an HTTP request to Salesforce Bulk API. :param context: The task context during execution. :return: API response if do_xcom_push is True """ sf_hook = SalesforceHook(salesforce_conn_id=self.salesforce_conn_id) conn = sf_hook.get_conn() bulk: SFBulkHandler = cast("SFBulkHandler", conn.__getattr__("bulk")) result: Iterable = [] if self.operation == "insert": result = bulk.__getattr__(self.object_name).insert( data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial ) elif self.operation == "update": result = bulk.__getattr__(self.object_name).update( data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial ) elif self.operation == "upsert": result = bulk.__getattr__(self.object_name).upsert( data=self.payload, external_id_field=self.external_id_field, batch_size=self.batch_size, use_serial=self.use_serial, ) elif self.operation == "delete": result = bulk.__getattr__(self.object_name).delete( data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial ) elif self.operation == "hard_delete": result = bulk.__getattr__(self.object_name).hard_delete( data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial ) if self.do_xcom_push and result: return result return None

Was this entry helpful?