apple / apple/foundationdb

Document retryable errors a watch future might throw

Open
#2,304 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

In particular, a watch might throw `cluster_version_changed` during an upgrade, which a client should probably retry, but the client might not be waiting on the future within a standard `onError` style retry loop.

Contributor guide

Open the contributing guide

Research direction

Review the existing documentation for watch futures and retry behavior, then identify where retryable errors are listed. Document errors such as cluster_version_changed and explain that callers may need to retry even when they are not waiting within a standard onError retry loop.

Written by the indexing model from the issue text.

Assessment

Domain
databases, distributed-systems, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.