Skip to content

Commit 74d074f

Browse files
committed
Tweak poolMaxPerShard doc
1 parent 6a158d3 commit 74d074f

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

doc/api.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1723,15 +1723,20 @@ oracledb.poolMax = 4;
17231723
Number poolMaxPerShard
17241724
```
17251725

1726-
Sets the maximum number of connections per [shard](#sharding) for connection
1727-
pools. This ensures that the pool is balanced towards each shard.
1726+
Sets the maximum number of connection in the pool that can be used for any
1727+
given shard in a sharded database. This lets connections in the pool be
1728+
balanced across the shards. A value of zero will not set any maximum number of
1729+
sessions for each shard.
17281730

17291731
This property may be overridden when [creating a connection pool](#createpool).
17301732

1731-
When this property is set, and a new connection request would cause the number
1732-
of connections to the target shard to exceed the limit, then that new connection
1733-
request will block until a suitable connection has been released back to the
1734-
pool. The pending connection request will consume one worker thread.
1733+
When this property is greater than zero, and a new connection request would
1734+
cause the number of connections to the target shard to exceed the limit, then
1735+
that new connection request will block until a suitable connection has been
1736+
released back to the pool. The pending connection request will consume one
1737+
worker thread.
1738+
1739+
See [Connecting to Sharded Databases](#sharding) for more information.
17351740

17361741
This property was added in node-oracledb 4.1. It is available when
17371742
node-oracledb uses Oracle client libraries 18.3, or later.

0 commit comments

Comments
 (0)