@@ -5591,7 +5591,7 @@ const commitNeeded = await connection.tpcPrepare(xid);
55915591Callback:
55925592
55935593```
5594- tpcRecover([Boolean asString,] function(Error error);
5594+ tpcRecover([Boolean asString,] function(Error error)) ;
55955595```
55965596
55975597Promise:
@@ -5627,7 +5627,7 @@ This function was added in node-oracledb 5.3.
56275627
56285628 Callback function parameter | Description
56295629 ----------------------------|-------------
5630- *Error error* | If `tpcRollback ()` succeeds, `error` is NULL. If an error occurs, then `error` contains the [error message](#errorobj).
5630+ *Error error* | If `tpcRecover ()` succeeds, `error` is NULL. If an error occurs, then `error` contains the [error message](#errorobj).
56315631
56325632#### <a name="contpcrollback"></a> 4.2.25 `connection.tpcRollback()`
56335633
@@ -9628,8 +9628,8 @@ connection can only execute one database operation at a time.
96289628Node.js has four background worker threads by default (not to be confused with
96299629the newer user space worker_threads module). If you open more than four
96309630[standalone connections](#connectionhandling) or pooled connections, such as by
9631- increasing [`poolMax`](#proppoolpoolmax), then you should increase the number
9632- of worker threads available to node-oracledb.
9631+ increasing [`poolMax`](#proppoolpoolmax), then you must increase the number of
9632+ worker threads available to node-oracledb.
96339633
96349634A worker thread pool that is too small can cause a decrease in application
96359635performance, can cause [deadlocks][22], or can cause connection requests to
@@ -9767,7 +9767,8 @@ When applications use a lot of connections for short periods, Oracle recommends
97679767using a connection pool for efficiency. Each connection in a pool should be
97689768used for a given unit of work, such as a transaction or a set of sequentially
97699769executed statements. Statements should be [executed sequentially, not in
9770- parallel](#numberofthreads) on each connection.
9770+ parallel](#parallelism) on each connection. The number of [worker
9771+ threads](#workerthreads) should be increased for large pools.
97719772
97729773Each node-oracledb process can use one or more connection pools. Each pool can
97739774contain zero or more connections. In addition to providing an immediately
@@ -9896,21 +9897,24 @@ The main characteristics of a connection pool are determined by its attributes
98969897[`poolIncrement`](#proppoolpoolincrement), and
98979898[`poolTimeout`](#proppoolpooltimeout).
98989899
9899- **Importantly, if you increase the size of the pool, you must increase the number
9900- of threads used by Node.js before Node.js starts its thread pool. See
9901- [Connections, Threads, and Parallelism ](#numberofthreads )**.
9900+ **Note: If you increase the size of the connection pool, you must increase the
9901+ number of threads in the Node.js worker thread pool. See [Connections and
9902+ Worker Threads](#workerthreads )**.
99029903
99039904Setting `poolMin` causes the specified number of connections to be established
99049905to the database during pool creation. This allows subsequent
99059906`pool.getConnection()` calls to return quickly for an initial set of users. An
99069907appropriate `poolMax` value avoids overloading the database by limiting the
99079908maximum number of connections ever opened.
99089909
9909- Pool expansion happens when the following are all true: (i)
9910- [`pool.getConnection()`](#getconnectionpool) is called and (ii) all the
9911- currently established connections in the pool are "checked out" by previous
9912- `pool.getConnection()` calls and are in-use by the application, and (iii) the
9913- number of those connections is less than the pool's `poolMax` setting.
9910+ Pool expansion happens when [`pool.getConnection()`](#getconnectionpool) is
9911+ called and both the following are true:
9912+
9913+ - all the currently established connections in the pool are "checked out" of
9914+ the pool by previous `pool.getConnection()` calls
9915+
9916+ - the number of those currently established connections is less than the pool's
9917+ `poolMax` setting.
99149918
99159919Pool shrinkage happens when the application returns connections to the pool,
99169920and they are then unused for more than [`poolTimeout`](#propdbpooltimeout)
@@ -10236,9 +10240,9 @@ If the application has called [`pool.getConnection()`](#getconnectionpool) (or
1023610240times so that all connections in the pool are in use, and further
1023710241`getConnection()` calls are made, then each of those new `getConnection()`
1023810242requests will be queued and not return until an in-use connection is released
10239- back to the pool with [`connection.close()`](#connectionclose). If `poolMax`
10240- has not been reached, then connection requests can be immediately satisfied and
10241- are not queued.
10243+ back to the pool with [`connection.close()`](#connectionclose). If, instead,
10244+ `poolMax` has not been reached, then connection requests can be immediately
10245+ satisfied and are not queued.
1024210246
1024310247The amount of time that a queued request will wait for a free connection can be
1024410248configured with [queueTimeout](#propdbqueuetimeout). When connections are timed
0 commit comments