Skip to content

Commit

Permalink
[docs] add batching in limitations of key-shared mode (apache#9153)
Browse files Browse the repository at this point in the history
### 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
  • Loading branch information
geomagilles authored Jan 8, 2021
1 parent 3e35af5 commit f7aa437
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion site2/docs/concepts-messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit f7aa437

Please sign in to comment.