Skip to content

Commit afb3bf3

Browse files
authored
Document sslmode connection string parameter (brianc#2421)
1 parent 54b8752 commit afb3bf3

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/pg-connection-string/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The resulting config contains a subset of the following properties:
2929
* `database` - Database name within the server
3030
* `client_encoding` - string encoding the client will use
3131
* `ssl`, either a boolean or an object with properties
32+
* `rejectUnauthorized`
3233
* `cert`
3334
* `key`
3435
* `ca`
@@ -65,6 +66,10 @@ Query parameters follow a `?` character, including the following special query p
6566
* `host=<host>` - sets `host` property, overriding the URL's host
6667
* `encoding=<encoding>` - sets the `client_encoding` property
6768
* `ssl=1`, `ssl=true`, `ssl=0`, `ssl=false` - sets `ssl` to true or false, accordingly
69+
* `sslmode=<sslmode>`
70+
* `sslmode=disable` - sets `ssl` to false
71+
* `sslmode=no-verify` - sets `ssl` to `{ rejectUnauthorized: false }`
72+
* `sslmode=prefer`, `sslmode=require`, `sslmode=verify-ca`, `sslmode=verify-full` - sets `ssl` to true
6873
* `sslcert=<filename>` - reads data from the given file and includes the result as `ssl.cert`
6974
* `sslkey=<filename>` - reads data from the given file and includes the result as `ssl.key`
7075
* `sslrootcert=<filename>` - reads data from the given file and includes the result as `ssl.ca`

0 commit comments

Comments
 (0)