Skip to content

Commit

Permalink
more readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
leafo committed Oct 13, 2021
1 parent 8b19285 commit 2fdc6d1
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,11 @@ of options. The table can have the following keys:
* `"ssl"`: enable ssl (default: `false`)
* `"ssl_verify"`: verify server certificate (default: `nil`)
* `"ssl_required"`: abort the connection if the server does not support SSL connections (default: `nil`)
* `"pool"`: optional name of pool to use when using OpenResty cosocket (defaults to `"#{host}:#{port}:#{database}"`)
* `"pool_size"`: optional size of pool to use when using OpenResty cosocket (default size equal to the value of the `lua_socket_pool_size` directive)
* `"backlog"`: optional size of backlog to use when using OpenResty cosocket.
If specified, this module will limit the total number of opened connections
for this pool. No more connections than `pool_size` can be opened
for this pool at any time. If the connection pool is full, subsequent
connect operations will be queued into a queue equal to this option's
value (the "backlog" queue).
* `"socket_type"`: optional, the type of socket to use, one of: `"nginx"`, `"luasocket"`, `cqueues` (default: `"nginx"` if in nginx, `"luasocket"` otherwise)
* `"application_name"`: set the name of the connection as displayed in `pg_stat_activity`. (default: `"pgmoon"`)
* `"pool"`: (OpenResty only) **optional** name of pool to use when using OpenResty cosocket (default: `"#{host}:#{port}:#{database}"`)
* `"pool_size"`: (OpenResty only) **optional** Passed directly to OpenResty cosocket connect function, [see docs](https://github.com/openresty/lua-nginx-module#tcpsockconnect)
* `"backlog"`: (OpenResty only) **optional** Passed directly to OpenResty cosocket connect function, [see docs](https://github.com/openresty/lua-nginx-module#tcpsockconnect)

Methods on the `Postgres` object returned by `new`:

Expand Down

0 comments on commit 2fdc6d1

Please sign in to comment.