Skip to content

docs: add note on pgx v5.11.0+ keyword/value connection string escaping #1166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgala2 merged 1 commit into from
Sep 28, 2026
Merged

docs: add note on pgx v5.11.0+ keyword/value connection string escaping #1166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,13 @@ with host set to the instance connection name. The returned `cleanup` func
will stop the dialer's background refresh goroutine and so should only be called
when you're done with the `Dialer`.

> [!NOTE]
>
> Keyword/value connection strings follow PostgreSQL `libpq` escaping rules
> (`pgx` `v5.11.0+`). If your password or other values contain spaces, single
> quotes (`'`), or backslashes (`\`), wrap the value in single quotes and escape
> `'` as `\'` and `\` as `\\`.

``` go
import (
"database/sql"
Expand Down
Loading