Skip to content

Commit 14a8814

Browse files
Pika-Gopherndyakov
andauthored
chore(docs): explain why MaxRetries is disabled for ClusterClient (#3551)
Co-authored-by: Nedyalko Dyakov <1547186+ndyakov@users.noreply.github.com>
1 parent 8ca21d2 commit 14a8814

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

osscluster.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ type ClusterOptions struct {
7777
CredentialsProviderContext func(ctx context.Context) (username string, password string, err error)
7878
StreamingCredentialsProvider auth.StreamingCredentialsProvider
7979

80+
// MaxRetries is the maximum number of retries before giving up.
81+
// For ClusterClient, retries are disabled by default (set to -1),
82+
// because the cluster client handles all kinds of retries internally.
83+
// This is intentional and differs from the standalone Options default.
8084
MaxRetries int
8185
MinRetryBackoff time.Duration
8286
MaxRetryBackoff time.Duration

0 commit comments

Comments
 (0)