ferruzzi commented on code in PR #24554:
URL: https://github.com/apache/airflow/pull/24554#discussion_r901889148
##########
airflow/providers/amazon/aws/sensors/sqs.py:
##########
@@ -104,14 +104,13 @@ def __init__(
self.hook: Optional[SqsHook] = None
- def poke(self, context: 'Context'):
+ def poll_sqs(self, sqs_conn: Any) -> Iterable:
+ """Poll SQS queue to retrieve messages
+ Args:
+ sqs_conn (Any): SQS connection
+ Returns:
+ Iterable: list of messages retrieved from SQS
Review Comment:
Not the format for docstrings that Airflow uses:
```suggestion
"""
Poll SQS queue to retrieve messages.
:param sqs_conn: SQS connection
:return: A list of messages retrieved from SQS
```
##########
airflow/providers/amazon/aws/sensors/sqs.py:
##########
@@ -215,3 +226,65 @@ def __init__(self, *args, **kwargs):
stacklevel=2,
)
super().__init__(*args, **kwargs)
+
+
+class SqsBatchSensor(SqsSensor):
+ """
+ Get messages from an Amazon SQS queue in batches and then delete the
retrieved messages from the queue.
+ If deletion of messages fails an AirflowException is thrown. Otherwise,
all messages
+ are pushed through XCom with the key ``messages``.
+ The total number of messages retrieved at maxium will be equal to the
number of messages retrived for each
+ SQS's API call multiplies with total number of call. Each SQS
receive_message can get a max 10 messages.
+ This sensor is identical to SQSSensor, except the fact that SQSSensor
performs one and only one SQS call
+ per poke, while SQSBatchSensor performs multiple SQS API calls per poke.
+ .. seealso::
+ For more information on how to use this sensor, take a look at the
guide:
+ :ref:`howto/sensor:SqsBatchSensor`
+ :param batch: The number of time the sensor will call the SQS to receive
messages (default: 1)
Review Comment:
Also, maybe add a line to the SqsSensor around L38, something like "The SQS
API can only return up to 10 messages in a single call. If a larger batch is
needed, consider using SqsBatchSensor."
##########
tests/system/providers/amazon/aws/example_sqs.py:
##########
@@ -66,6 +66,20 @@ def delete_queue(queue_url):
)
# [END howto_sensor_sqs]
+ # [START howto_sensor_sqs_batch]
+ # batch multiple messages from SQS.
+ # each SQS poll can retrieve no more than 10 messages
+ # due to requirements by AWS SQS
+ read_from_queue_in_batch = SqsBatchSensor(
+ task_id='read_from_queue_in_batch',
+ sqs_queue=create_queue,
+ # get maximum 10 messages each poll
+ max_messages=10,
+ # perform 3 polls before returning results
+ batch=3,
+ )
+ # [END howto_sensor_sqs_batch]
+
Review Comment:
Please add the task to the chain down [around
L88](https://github.com/apache/airflow/blob/46de72b63697b629c1fd9dddc1fa8ca412cb9df6/tests/system/providers/amazon/aws/example_sqs.py#L88).
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
