Skip to content

Commit b7fe970

Browse files
committed
Document poolIncrement for external authentication
1 parent f2445f5 commit b7fe970

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

doc/api.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1889,7 +1889,7 @@ release all connections and terminate the connection pool by calling
18891889
the [`terminate()`](#terminate) method on the Pool object.
18901890
18911891
The growth characteristics of a connection pool are determined by the
1892-
Pool attributes[`poolIncrement`](#proppoolpoolincrement),
1892+
Pool attributes [`poolIncrement`](#proppoolpoolincrement),
18931893
[`poolMax`](#proppoolpoolmax), [`poolMin`](#proppoolpoolmin) and
18941894
[`poolTimeout`](#proppoolpooltimeout). Note that when External
18951895
Authentication is used, the pool behavior is different, see
@@ -1988,11 +1988,13 @@ object are always obtained in the manner in which the pool was
19881988
initially created.
19891989
19901990
For pools created with external authentication, the number of
1991-
connections initially created is zero even if a non-zero value is
1992-
specified for the [`poolMin`](#propdbpoolmin). However, once the
1993-
number of open connections exceeds `poolMin` and connections are idle
1994-
for more than the [`poolTimeout`](#propdbpooltimeout) seconds, then
1995-
the number of open connections does not fall below `poolMin`.
1991+
connections initially created is zero even if a larger value is
1992+
specified for [`poolMin`](#propdbpoolmin). The pool increment is
1993+
always 1, regardless of the value of
1994+
[`poolIncrement`](#proppoolpoolincrement). Once the number
1995+
of open connections exceeds `poolMin` and connections are idle for
1996+
more than the [`poolTimeout`](#propdbpooltimeout) seconds, then the
1997+
number of open connections does not fall below `poolMin`.
19961998
19971999
## <a name="sqlexecution"></a> 9. SQL Execution
19982000

0 commit comments

Comments
 (0)