Skip to content

Commit 91f7309

Browse files
committed
doc/comment changes
1 parent fb11b2c commit 91f7309

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,14 +276,14 @@ Default: false
276276
```
277277

278278

279-
RejectreadOnly causes the driver to reject read-only connections. This is for a
280-
possible race condition during an automatic failover, where the mysql client
281-
gets connected to a read-only replica after the failover.
279+
`rejectreadOnly=true` causes the driver to reject read-only connections. This
280+
is for a possible race condition during an automatic failover, where the mysql
281+
client gets connected to a read-only replica after the failover.
282282

283283
Note that this should be a fairly rare case, as an automatic failover normally
284284
happens when the primary is down, and the race condition shouldn't happen
285285
unless it comes back up online as soon as the failover is kicked off. On the
286-
other hand, when this happens, an mysql application can get stuck on a
286+
other hand, when this happens, a MySQL application can get stuck on a
287287
read-only connection until restarted. It is however fairly easy to reproduce,
288288
for example, using a manual failover on AWS Aurora's MySQL-compatible cluster.
289289

dsn.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ type Config struct {
5353
InterpolateParams bool // Interpolate placeholders into query string
5454
MultiStatements bool // Allow multiple statements in one query
5555
ParseTime bool // Parse time values to time.Time
56-
RejectReadOnly bool // Reject read-only connections; see README.md
56+
RejectReadOnly bool // Reject read-only connections
5757
Strict bool // Return warnings as errors
5858
}
5959

0 commit comments

Comments
 (0)