Skip to content

Commit 7649129

Browse files
author
Christopher Jones
committed
Fix getStatistics() and logStatistics() signature doc
1 parent 5f36d8f commit 7649129

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

doc/api.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6011,22 +6011,15 @@ pools.
60116011

60126012
##### Prototype
60136013

6014-
Callback:
60156014
```
6016-
getStatistics(function(Error error, Object poolStatistics){});
6017-
```
6018-
6019-
Promise:
6020-
6021-
```
6022-
promise = getStatistics();
6015+
getStatistics();
60236016
```
60246017

60256018
##### Description
60266019

60276020
Returns an object containing pool queue statistics, pool settings, and related
60286021
environment variables. The object is described in [Connection Pool
6029-
Monitoring](#connpoolmonitor).
6022+
Monitoring](#connpoolmonitor). Note that this is a synchronous method.
60306023

60316024
Recording of statistics must have previously been enabled with
60326025
[`enableStatistics`](#createpoolpoolattrsstats) during pool creation or with
@@ -6042,23 +6035,17 @@ This function was added in node-oracledb 5.2.
60426035

60436036
##### Prototype
60446037

6045-
Callback:
6046-
```
6047-
logStatistics(function(Error error){});
6048-
```
6049-
6050-
Promise:
6051-
60526038
```
6053-
promise = logStatistics();
6039+
logStatistics();
60546040
```
60556041

60566042
##### Description
60576043

60586044
Displays pool queue statistics, pool settings, and related environment
60596045
variables to the console. Recording of statistics must have previously been
60606046
enabled with [`enableStatistics`](#createpoolpoolattrsstats) during pool
6061-
creation or with [`pool.reconfigure()`](#poolreconfigure).
6047+
creation or with [`pool.reconfigure()`](#poolreconfigure). Note that this is a
6048+
synchronous method.
60626049

60636050
An error will be thrown if `logStatistics()` is called while the pool is
60646051
closed, draining, [reconfiguring](#poolreconfigure), or when `enableStatistics`

0 commit comments

Comments
 (0)