minor #20607 [Messenger] Update docs for keepalive support in doctrine messenger transport (OskarStark)

javiereguiluz · javiereguiluz · commit fb94df53399f · 2025-01-31T09:03:25.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [Messenger] Update docs for keepalive support in doctrine messenger transport Replaces * #20603 closes #20599 cc `@silasjoisten` Commits ------- 40cafd4 [Messenger] Update docs for keepalive support in doctrine messenger transport
diff --git a/messenger.rst b/messenger.rst
@@ -545,12 +545,16 @@ command with the ``--all`` option:
 
 The ``--keepalive`` option can be used to prevent messages from being prematurely
 redelivered during long-running processing. It marks the message as "in progress"
-and prevents it from being redelivered until the worker finishes processing it.
+and prevents it from being redelivered until the worker finishes processing it:
+
+.. code-block:: terminal
+
+    php bin/console messenger:consume --keepalive=5
 
 .. note::
 
     This option is only available for supported transports, which are
-    the Beanstalkd and AmazonSQS transports.
+    the Doctrine, Beanstalkd and AmazonSQS transports.
 
 .. versionadded:: 7.2
 
@@ -1689,6 +1693,14 @@ in the table.
     The length of time to wait for a response when calling
     ``PDO::pgsqlGetNotify``, in milliseconds.
 
+The keepalive feature, which prevents messages from being prematurely redelivered during
+long-running processing, updates the ``delivered_at`` timestamp periodically to ensure
+the message is marked as "in progress".
+
+.. versionadded:: 7.3
+
+    Keepalive support, using the ``--keepalive`` option, was added in Symfony 7.3.
+
 Beanstalkd Transport
 ~~~~~~~~~~~~~~~~~~~~
 
