Skip to content

Commit c4e408e

Browse files
committed
Add poolMaxPerShard caveat
1 parent 31d8cff commit c4e408e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/api.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1498,6 +1498,13 @@ pools. This ensures that the pool is balanced towards each shard.
14981498

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

1501+
When this property is set, and a new connection request would cause the number
1502+
of connections to the target shard to exceed the limit, then that new connection
1503+
request will block until a suitable connection has been released back to the
1504+
pool. Importantly, when blocked, the [`queueTimeout`](#propdbqueuetimeout)
1505+
value will be ignored and the pending connection request will consume one worker
1506+
thread.
1507+
15011508
This property was added in node-oracledb 4.1. It is available when
15021509
node-oracledb uses Oracle client libraries 18.3, or later.
15031510

0 commit comments

Comments
 (0)