docs: update Unsubscribe interface comment (#1146)

Co-authored-by: ninjazhou <ninjazhou@tencent.com>
apache · Jan 2, 2024 · 3a1a766 · 3a1a766
1 parent f491e09
commit 3a1a766
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/pulsar/consumer.go b/pulsar/consumer.go
@@ -254,6 +254,12 @@ type Consumer interface {
 	Subscription() string
 
 	// Unsubscribe the consumer
+	//
+	// Unsubscribing will cause the subscription to be deleted,
+	// and all the retained data can potentially be deleted based on message retention and ttl policy.
+	//
+	// This operation will fail when performed on a shared subscription
+	// where more than one consumer are currently connected.
 	Unsubscribe() error
 
 	// Receive a single message.