[KAFKA-356] Update poll.await.time.ms documentation Created: 23/Feb/23  Updated: 28/Oct/23  Resolved: 30/Mar/23

Status: Closed
Project: Kafka Connector
Component/s: Source
Affects Version/s: None
Fix Version/s: 1.10.0

Type: Improvement Priority: Unknown
Reporter: Ross Lawley Assignee: Ross Lawley
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
Related
is related to KAFKA-306 Ensure `poll.await.time.ms`only is us... Closed
is related to KAFKA-355 poll.await.time.ms in source connect... Closed
Documentation Changes: Needed
Documentation Changes Summary:

Update poll.await.time.ms documentation here: https://www.mongodb.com/docs/kafka-connector/current/source-connector/configuration-properties/change-stream/

To be:

The maximum amount of time in milliseconds the server waits for new data changes to report to the change stream cursor before returning an empty batch.


 Description   

In KAFKA-306 the logic was simplified by using poll.await.time.ms via ChangeStreamIterable.maxAwaitTime instead of blocking in the MongoSourceTask.poll().

The documentation of the configuration should be updated in the code as well as: https://www.mongodb.com/docs/kafka-connector/current/source-connector/configuration-properties/change-stream/



 Comments   
Comment by Githook User [ 30/Mar/23 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Clarify poll.await.time.ms documentation

KAFKA-356
Branch: master
https://github.com/mongodb/mongo-kafka/commit/51b60cf54694892f7271d1ee6969457012b9be02

Generated at Thu Feb 08 09:06:11 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.