Skip to content

Commit 382ba4f

Browse files
committed
docs: make gossipTimeout description mode-neutral
The previous wording implied a timeout always moves to the next candidate, but with +discover there is only one candidate and the discovery loop retries the same endpoint instead.
1 parent 67bdd12 commit 382ba4f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/api/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ There are a number of query parameters that can be used in the connection string
8181
| `connectionName` | Any string | None | Connection name |
8282
| `maxDiscoverAttempts` | Number | `10` | Number of attempts to discover the cluster. |
8383
| `discoveryInterval` | Number | `100` | Cluster discovery polling interval in milliseconds. |
84-
| `gossipTimeout` | Number | `5` | Gossip timeout in seconds. If the gossip call times out, the next candidate endpoint will be tried. |
84+
| `gossipTimeout` | Number | `5` | Timeout in seconds for each gossip request during cluster discovery. |
8585
| `nodePreference` | `leader`, `follower`, `random`, `readOnlyReplica` | `leader` | Preferred node role. When creating a client for write operations, always use `leader`. |
8686
| `tlsVerifyCert` | `true`, `false` | `true` | In secure mode, set to `true` when using an untrusted connection to the node if you don't have the CA file available. Don't use in production. |
8787
| `tlsCaFile` | String, file path | None | Path to the CA file when connecting to a secure cluster with a certificate that's not signed by a trusted CA. |

0 commit comments

Comments
 (0)