You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by si...@apache.org on 2021/01/08 21:30:21 UTC

[pulsar] branch master updated: [docs] add batching in limitations of key-shared mode (#9153)

This is an automated email from the ASF dual-hosted git repository.

sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new f7aa437  [docs] add batching in limitations of key-shared mode (#9153)
f7aa437 is described below

commit f7aa437bbdad405051b3abcf3697a3ab63289b11
Author: Gilles Barbier <gi...@zenaton.com>
AuthorDate: Fri Jan 8 22:29:51 2021 +0100

    [docs] add batching in limitations of key-shared mode (#9153)
    
    ### Motivation
    
    Using KeyShared with batching can lead to vicious bugs as batching remove the guarantee of having a unique consumer handling a given key. I've spent some time debugging this and think it worth stating that in the key-shared limitation
    
    ### Modifications
    
    Just added Batching as a limitation of Key-Shared mode.
    
    ### Verifying this change
    
    This change is a trivial rework / code cleanup without any test coverage.
    
    yes
    
    This change is already covered by existing tests, such as *(please describe tests)*.
    
    yes
---
 site2/docs/concepts-messaging.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/site2/docs/concepts-messaging.md b/site2/docs/concepts-messaging.md
index 0a456f3..764a977 100644
--- a/site2/docs/concepts-messaging.md
+++ b/site2/docs/concepts-messaging.md
@@ -286,8 +286,9 @@ In *Key_Shared* mode, multiple consumers can attach to the same subscription. Me
 
 > #### Limitations of Key_Shared mode
 > When you use Key_Shared mode, be aware that:
-> * You need to specify a key or orderingKey for messages
+> * You need to specify a key or orderingKey for messages.
 > * You cannot use cumulative acknowledgment with Key_Shared mode.
+> * Your producers should disable batching or use a key-based batch builder.
 
 ![Key_Shared subscriptions](assets/pulsar-key-shared-subscriptions.png)