Skip to content

Commit 3518a75

Browse files
authored
Add note about default pg pool size (#286)
1 parent 08ce51a commit 3518a75

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

src/pages/postgraphile/usage-library.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,11 @@ The `postgraphile` middleware factory function takes three arguments, all of
301301
which are optional. The below options are valid for
302302
<tt>postgraphile@<!-- LIBRARY_VERSION_BEGIN -->4.12.3<!-- LIBRARY_VERSION_END --></tt>.
303303

304-
- **`pgConfig`**: An object or string that will be passed to the [`pg`][]
305-
library and used to connect to a PostgreSQL backend, OR a pg.Pool to use.
304+
- **`pgConfig`**: Specifies the PostgreSQL database you wish to connect to.
305+
You may pass a PostgreSQL connection string, a configuration object to pass
306+
to the [`pg.Pool`][] constructor, or a [`pg.Pool`][] instance. Note: `pg.Pool`
307+
has a default pool size of 10, to increase this you use the configuration
308+
object/pg.Pool instance approach and pass a different value as `max`.
306309
- **`schemaName`**: A string, or array of strings, which specifies the
307310
PostgreSQL schema(s) you to expose via PostGraphile; defaults to 'public'
308311
- **`options`**: An object containing other miscellaneous options. Options
@@ -739,4 +742,5 @@ You can find
739742
[express]: https://www.npmjs.com/express
740743
[graphql/express-graphql#82]: https://github.com/graphql/express-graphql/pull/82
741744
[`pg`]: https://www.npmjs.com/pg
745+
[`pg.Pool`]: https://node-postgres.com/api/pool
742746
[morgan]: https://www.npmjs.com/morgan

0 commit comments

Comments
 (0)