Skip to content

Commit 1d59297

Browse files
committed
Duplicate defaults in pool property section
1 parent 17e4703 commit 1d59297

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

doc/api.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ it is possible for un-usable connections to be returned by a pool
778778
to occur after `getConnection()` is called, applications should
779779
implement appropriate statement execution error checking.
780780

781-
The default value is `60` seconds. Possible values for `poolPingInterval` are:
781+
The default value is 60 seconds. Possible values for `poolPingInterval` are:
782782

783783
`poolPingInterval` Value | Behavior of a Pool `getConnection()` Call
784784
----------|------------------------------------------
@@ -1062,6 +1062,8 @@ Boolean externalAuth
10621062
Indicate whether connections should be established using
10631063
[External Authentication](#extauth).
10641064

1065+
The default is *false*.
1066+
10651067
This optional property overrides the
10661068
[`oracledb.externalAuth`](#propdbisexternalauth) property.
10671069

@@ -1100,6 +1102,8 @@ Number poolIncrement
11001102
The number of connections that are opened whenever a connection
11011103
request exceeds the number of currently open connections.
11021104

1105+
The default value is 1.
1106+
11031107
This optional property overrides the
11041108
[`oracledb.poolIncrement`](#propdbpoolincrement) property.
11051109

@@ -1109,6 +1113,8 @@ Number poolMax
11091113

11101114
The maximum number of connections to which a connection pool can grow.
11111115

1116+
The default value is 4.
1117+
11121118
This optional property overrides the
11131119
[`oracledb.poolMax`](#propdbpoolmax) property.
11141120

@@ -1119,6 +1125,8 @@ Number poolMin
11191125
The minimum number of connections a connection pool maintains, even
11201126
when there is no activity to the target database.
11211127

1128+
The default value is 0.
1129+
11221130
This optional property overrides the
11231131
[`oracledb.poolMin`](#propdbpoolmin) property.
11241132

@@ -1135,17 +1143,22 @@ Note this attribute is ignored when node-oracledb is built with Oracle
11351143
client 12.2, since this has its own lightweight, always-enabled
11361144
connection check.
11371145

1146+
The default value is 60.
1147+
11381148
This optional property overrides the
11391149
[`oracledb.poolPingInterval`](#propdbpoolpinginterval) property.
11401150

1151+
See [Connection Pool Pinging](#connpoolpinging) for more discussion.
1152+
11411153
```
11421154
Number poolTimeout
11431155
```
11441156

11451157
The number of seconds after which idle connections (unused in the
11461158
pool) may be terminated. Idle connections are terminated only when
1147-
the pool is accessed. If `poolTimeout` is set to 0, then idle
1148-
connections are never terminated.
1159+
the pool is accessed.
1160+
1161+
The default value is 60.
11491162

11501163
This optional property overrides the
11511164
[`oracledb.poolTimeout`](#propdbpooltimeout) property.
@@ -1154,10 +1167,12 @@ This optional property overrides the
11541167
Boolean queueRequests
11551168
```
11561169

1157-
Indicate whether [`pool.getConnection()`](#getconnectionpool)
1170+
Indicates whether [`pool.getConnection()`](#getconnectionpool)
11581171
(or [`oracledb.getConnection()`](#getconnectiondb) calls that use a pool)
11591172
should be queued when all available connections in the pool are currently in use.
11601173

1174+
The default value is *true*.
1175+
11611176
This optional property overrides the
11621177
[`oracledb.queueRequests`](#propdbqueuerequests) property.
11631178

@@ -1169,6 +1184,8 @@ The number of milliseconds after which connection requests waiting in the
11691184
connection request queue are terminated. If `queueTimeout` is
11701185
set to 0, then queued connection requests are never terminated.
11711186

1187+
The default value is 60000.
1188+
11721189
This optional property overrides the
11731190
[`oracledb.queueTimeout`](#propdbqueuetimeout) property.
11741191

0 commit comments

Comments
 (0)