[GitHub] [airflow] eladkal commented on a diff in pull request #24473: Add support for Salesforce bulk api

[GitBox <gi...@apache.org>]

eladkal commented on code in PR #24473:
URL: https://github.com/apache/airflow/pull/24473#discussion_r913038315


##########
airflow/providers/salesforce/operators/bulk.py:
##########
@@ -0,0 +1,113 @@
+# 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 typing import TYPE_CHECKING, Optional
+
+from airflow.models import BaseOperator
+from airflow.providers.salesforce.hooks.salesforce import SalesforceHook
+
+if TYPE_CHECKING:
+    from airflow.utils.context import Context
+
+
+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>`.
+    """
+
+    def __init__(
+        self,
+        *,
+        operation: Optional[str] = None,
+        object_name: Optional[str] = None,
+        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' is missing.")
+
+        available_operations = ['insert', 'update', 'upsert', 'delete', 'hard_delete']
+        if self.operation not in available_operations:
+            raise ValueError(f"Operation not found! Available operations are {available_operations}.")
+
+    def execute(self, context: 'Context') -> dict:
+        """
+        Makes an HTTP request to Salesforce Bulk API.
+
+        :param context: The task context during execution.
+        :return: API response if do_xcom_push is True
+        :rtype: dict
+        """
+        sf_hook = SalesforceHook(salesforce_conn_id=self.salesforce_conn_id)
+        conn = sf_hook.get_conn()
+
+        result: dict = {}
+        if self.operation == 'insert':
+            result = conn.bulk.__getattr__(self.object_name).insert(
+                data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial
+            )
+        elif self.operation == 'update':
+            result = conn.bulk.__getattr__(self.object_name).update(
+                data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial
+            )
+        elif self.operation == 'upsert':
+            result = conn.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 = conn.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 = conn.bulk.__getattr__(self.object_name).hard_delete(
+                data=self.payload, batch_size=self.batch_size, use_serial=self.use_serial
+            )
+
+        if not self.do_xcom_push:
+            result = {}

Review Comment:
   One last comment...
   
   Didn't we say we don't want to push empty dict?
   https://github.com/apache/airflow/pull/24473#discussion_r902548285
   
   We should return None if nothing to push
   see for example
   https://github.com/apache/airflow/blob/ec6761a5c0d031221d53ce213c0e42813606c55d/airflow/providers/amazon/aws/operators/ecs.py#L312-L315
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org