Skip to content

Commit 20e66f6

Browse files
committed
Update pool cache doc
1 parent e91f69e commit 20e66f6

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

doc/api.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,14 @@ limitations under the License.
9797
- 6.1 [Pool Properties](#poolproperties)
9898
- 6.1.1 [`connectionsInUse`](#proppoolconnectionsinuse)
9999
- 6.1.2 [`connectionsOpen`](#proppoolconnectionsopen)
100-
- 6.1.3 [`poolIncrement`](#proppoolpoolincrement)
101-
- 6.1.4 [`poolMax`](#proppoolpoolmax)
102-
- 6.1.5 [`poolMin`](#proppoolpoolmin)
103-
- 6.1.6 [`poolTimeout`](#proppoolpooltimeout)
104-
- 6.1.7 [`queueRequests`](#proppoolqueuerequests)
105-
- 6.1.8 [`queueTimeout`](#proppoolqueueTimeout)
106-
- 6.1.9 [`stmtCacheSize`](#proppoolstmtcachesize)
100+
- 6.1.3 [`poolAlias`](#proppoolpoolalias)
101+
- 6.1.4 [`poolIncrement`](#proppoolpoolincrement)
102+
- 6.1.5 [`poolMax`](#proppoolpoolmax)
103+
- 6.1.6 [`poolMin`](#proppoolpoolmin)
104+
- 6.1.7 [`poolTimeout`](#proppoolpooltimeout)
105+
- 6.1.8 [`queueRequests`](#proppoolqueuerequests)
106+
- 6.1.9 [`queueTimeout`](#proppoolqueueTimeout)
107+
- 6.1.10 [`stmtCacheSize`](#proppoolstmtcachesize)
107108
- 6.2 [Pool Methods](#poolmethods)
108109
- 6.2.1 [`close()`](#poolclose)
109110
- 6.2.2 [`getConnection()`](#getconnectionpool)
@@ -1864,7 +1865,15 @@ readonly Number connectionsOpen
18641865
The number of currently open connections in the underlying connection
18651866
pool.
18661867

1867-
#### <a name="proppoolpoolincrement"></a> 6.1.3 poolIncrement
1868+
#### <a name="proppoolpoolalias"></a> 6.1.3 poolAlias
1869+
1870+
```
1871+
readonly Number poolAlias
1872+
```
1873+
1874+
The alias of this pool in the [connection pool cache](#connpoolcache). An alias cannot be changed once the pool has been created.
1875+
1876+
#### <a name="proppoolpoolincrement"></a> 6.1.4 poolIncrement
18681877

18691878
```
18701879
readonly Number poolIncrement
@@ -1873,7 +1882,7 @@ readonly Number poolIncrement
18731882
The number of connections that are opened whenever a connection
18741883
request exceeds the number of currently open connections.
18751884

1876-
#### <a name="proppoolpoolmax"></a> 6.1.4 poolMax
1885+
#### <a name="proppoolpoolmax"></a> 6.1.5 poolMax
18771886

18781887
```
18791888
readonly Number poolMax
@@ -1882,7 +1891,7 @@ readonly Number poolMax
18821891
The maximum number of connections that can be open in the connection
18831892
pool.
18841893

1885-
#### <a name="proppoolpoolmin"></a> 6.1.5 poolMin
1894+
#### <a name="proppoolpoolmin"></a> 6.1.6 poolMin
18861895

18871896
```
18881897
readonly Number poolMin
@@ -1891,7 +1900,7 @@ readonly Number poolMin
18911900
The minimum number of connections a connection pool maintains, even
18921901
when there is no activity to the target database.
18931902

1894-
#### <a name="proppoolpooltimeout"></a> 6.1.6 poolTimeout
1903+
#### <a name="proppoolpooltimeout"></a> 6.1.7 poolTimeout
18951904

18961905
```
18971906
readonly Number poolTimeout
@@ -1901,7 +1910,7 @@ The time (in seconds) after which the pool terminates idle connections
19011910
(unused in the pool). The number of connections does not drop below
19021911
poolMin.
19031912

1904-
#### <a name="proppoolqueuerequests"></a> 6.1.7 queueRequests
1913+
#### <a name="proppoolqueuerequests"></a> 6.1.8 queueRequests
19051914

19061915
```
19071916
readonly Boolean queueRequests
@@ -1911,7 +1920,7 @@ Determines whether requests for connections from the pool are queued
19111920
when the number of connections "checked out" from the pool has reached
19121921
the maximum number specified by [`poolMax`](#propdbpoolmax).
19131922

1914-
#### <a name="proppoolqueueTimeout"></a> 6.1.8 queueTimeout
1923+
#### <a name="proppoolqueueTimeout"></a> 6.1.9 queueTimeout
19151924

19161925
```
19171926
readonly Number queueTimeout
@@ -1920,7 +1929,7 @@ readonly Number queueTimeout
19201929
The time (in milliseconds) that a connection request should wait in
19211930
the queue before the request is terminated.
19221931

1923-
#### <a name="proppoolstmtcachesize"></a> 6.1.9 stmtCacheSize
1932+
#### <a name="proppoolstmtcachesize"></a> 6.1.10 stmtCacheSize
19241933

19251934
```
19261935
readonly Number stmtCacheSize
@@ -1951,7 +1960,7 @@ This call terminates the connection pool.
19511960
Any open connections should be released with [`connection.close()`](#connectionclose)
19521961
before `pool.close()` is called.
19531962

1954-
If the pool was cached in the [connection pool cache](#connpoolcache) it will be removed automatically.
1963+
If the pool is in the [connection pool cache](#connpoolcache) it will be removed from the cache.
19551964

19561965
##### Parameters
19571966

@@ -2422,7 +2431,7 @@ Methods that can affect or use the connection pool cache include:
24222431
- [oracledb.createPool()](#createpool) - can add a pool to the cache
24232432
- [oracledb.getPool()](#getpool) - retrieves a pool from the cache (synchronous)
24242433
- [oracledb.getConnection()](#getconnectiondb) - can use a pool in the cache to retrieve connections
2425-
- [pool.close()](#closepool) - automatically removes the pool from the cache if needed
2434+
- [pool.close()](#poolclose) - automatically removes the pool from the cache if needed
24262435
24272436
Pools are added to the cache if a [`poolAlias`](#createpoolpoolattrspoolalias)
24282437
property is provided in the [`poolAttrs`](#createpoolpoolattrs) object when

0 commit comments

Comments
 (0)