@@ -97,13 +97,14 @@ limitations under the License.
97
97
- 6.1 [ Pool Properties] ( #poolproperties )
98
98
- 6.1.1 [ ` connectionsInUse ` ] ( #proppoolconnectionsinuse )
99
99
- 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 )
107
108
- 6.2 [ Pool Methods] ( #poolmethods )
108
109
- 6.2.1 [ ` close() ` ] ( #poolclose )
109
110
- 6.2.2 [ ` getConnection() ` ] ( #getconnectionpool )
@@ -1864,7 +1865,15 @@ readonly Number connectionsOpen
1864
1865
The number of currently open connections in the underlying connection
1865
1866
pool.
1866
1867
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
1868
1877
1869
1878
```
1870
1879
readonly Number poolIncrement
@@ -1873,7 +1882,7 @@ readonly Number poolIncrement
1873
1882
The number of connections that are opened whenever a connection
1874
1883
request exceeds the number of currently open connections.
1875
1884
1876
- #### <a name =" proppoolpoolmax " ></a > 6.1.4 poolMax
1885
+ #### <a name =" proppoolpoolmax " ></a > 6.1.5 poolMax
1877
1886
1878
1887
```
1879
1888
readonly Number poolMax
@@ -1882,7 +1891,7 @@ readonly Number poolMax
1882
1891
The maximum number of connections that can be open in the connection
1883
1892
pool.
1884
1893
1885
- #### <a name =" proppoolpoolmin " ></a > 6.1.5 poolMin
1894
+ #### <a name =" proppoolpoolmin " ></a > 6.1.6 poolMin
1886
1895
1887
1896
```
1888
1897
readonly Number poolMin
@@ -1891,7 +1900,7 @@ readonly Number poolMin
1891
1900
The minimum number of connections a connection pool maintains, even
1892
1901
when there is no activity to the target database.
1893
1902
1894
- #### <a name =" proppoolpooltimeout " ></a > 6.1.6 poolTimeout
1903
+ #### <a name =" proppoolpooltimeout " ></a > 6.1.7 poolTimeout
1895
1904
1896
1905
```
1897
1906
readonly Number poolTimeout
@@ -1901,7 +1910,7 @@ The time (in seconds) after which the pool terminates idle connections
1901
1910
(unused in the pool). The number of connections does not drop below
1902
1911
poolMin.
1903
1912
1904
- #### <a name =" proppoolqueuerequests " ></a > 6.1.7 queueRequests
1913
+ #### <a name =" proppoolqueuerequests " ></a > 6.1.8 queueRequests
1905
1914
1906
1915
```
1907
1916
readonly Boolean queueRequests
@@ -1911,7 +1920,7 @@ Determines whether requests for connections from the pool are queued
1911
1920
when the number of connections "checked out" from the pool has reached
1912
1921
the maximum number specified by [ ` poolMax ` ] ( #propdbpoolmax ) .
1913
1922
1914
- #### <a name =" proppoolqueueTimeout " ></a > 6.1.8 queueTimeout
1923
+ #### <a name =" proppoolqueueTimeout " ></a > 6.1.9 queueTimeout
1915
1924
1916
1925
```
1917
1926
readonly Number queueTimeout
@@ -1920,7 +1929,7 @@ readonly Number queueTimeout
1920
1929
The time (in milliseconds) that a connection request should wait in
1921
1930
the queue before the request is terminated.
1922
1931
1923
- #### <a name =" proppoolstmtcachesize " ></a > 6.1.9 stmtCacheSize
1932
+ #### <a name =" proppoolstmtcachesize " ></a > 6.1.10 stmtCacheSize
1924
1933
1925
1934
```
1926
1935
readonly Number stmtCacheSize
@@ -1951,7 +1960,7 @@ This call terminates the connection pool.
1951
1960
Any open connections should be released with [ ` connection.close() ` ] ( #connectionclose )
1952
1961
before ` pool.close() ` is called.
1953
1962
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 .
1955
1964
1956
1965
##### Parameters
1957
1966
@@ -2422,7 +2431,7 @@ Methods that can affect or use the connection pool cache include:
2422
2431
- [oracledb.createPool()](#createpool) - can add a pool to the cache
2423
2432
- [oracledb.getPool()](#getpool) - retrieves a pool from the cache (synchronous)
2424
2433
- [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
2426
2435
2427
2436
Pools are added to the cache if a [` poolAlias` ](#createpoolpoolattrspoolalias)
2428
2437
property is provided in the [` poolAttrs` ](#createpoolpoolattrs) object when
0 commit comments