You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/api.md
+47-21Lines changed: 47 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -255,21 +255,28 @@ and preventing any session information leaking between the two systems.
255
255
Boolean isAutoCommit
256
256
```
257
257
258
-
If this parameter is true, each [DML](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CNCPT2042) statement is
259
-
automatically committed.
258
+
If this parameter is true, then the transaction in the current
259
+
connection is automatically committed at the the end of statement
260
+
execution.
260
261
261
-
By default, this property is false.
262
+
The default value is false.
263
+
264
+
This parameter may be overridden in an `execute()` call.
265
+
266
+
Note: Oracle Database will implicitly commit when a [DDL](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CHDJJGGF) statement is executed irrespective of the value of this property.
262
267
263
268
<aname="propdbmaxrows"></a>
264
269
```
265
270
Number maxRows
266
271
```
267
272
268
273
The maximum number of rows that are fetched by the `execute()` call of the *Connection*
269
-
object. This parameter may be overridden during the `execute()` call.
274
+
object.
270
275
271
276
The default value is 100.
272
277
278
+
This parameter may be overridden in an `execute()` call.
279
+
273
280
To improve database efficiency, SQL queries should use a row
for each Pool object. The default properties may be overridden by
376
-
specifying new properties in the `poolAttrs` parameter.
388
+
for each Pool object.
389
+
390
+
The default properties may be overridden by specifying new properties
391
+
in the `poolAttrs` parameter.
377
392
378
393
A pool should be terminated with the `pool.terminate()` call.
379
394
@@ -620,7 +635,7 @@ values.
620
635
621
636
<aname="proppoolconnectionsinuse"></a>
622
637
```
623
-
readonly Boolean connectionsInUse
638
+
readonly Number connectionsInUse
624
639
```
625
640
626
641
The number of currently active connections in the connection pool
@@ -674,9 +689,12 @@ readonly Number stmtCacheSize
674
689
```
675
690
676
691
The number of statements that must be cached in the [statement cache](#stmtcache) of
677
-
each connection. This parameter may be overridden for a specific
678
-
Connection object. The default is the `stmtCacheSize` property of the
679
-
*Oracledb* object when the pool is created.
692
+
each connection.
693
+
694
+
The default is the `stmtCacheSize` property of the *Oracledb* object
695
+
when the pool is created.
696
+
697
+
This parameter may be overridden for a specific Connection object.
680
698
681
699
### <aname="poolmethods"></a> 4.2 Pool Methods
682
700
@@ -949,7 +967,7 @@ Option Property | Description
949
967
----------------|-------------
950
968
*Number maxRows* | Number of rows to fetch for `SELECT` statements. To improve database efficiency, SQL queries should use a row limiting clause like [OFFSET / FETCH](https://docs.oracle.com/database/121/SQLRF/statements_10002.htm#BABEAACC) or equivalent. The `maxRows` attribute can be used to stop badly coded queries from returning unexpectedly large numbers of rows.
951
969
*String outFormat* | The format of rows fetched for `SELECT` statements. This can be either `ARRAY` or `OBJECT`. If specified as `ARRAY`, then each row is fetched as an array of column values. If specified as `OBJECT`, then each row is fetched as a JavaScript object.
952
-
*Boolean isAutoCommit* | If it is true, then each [DML](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CNCPT2042) is automatically committed. Note: Oracle Database will implicitly commit when a [DDL](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CHDJJGGF)statement is executed.
970
+
*Boolean isAutoCommit* | This overrides the `oracledb.isAutoCommit` property for this statement execution.
953
971
954
972
```
955
973
function(Error error, [Object result])
@@ -1327,7 +1345,15 @@ The statement cache can be automatically tuned with the
0 commit comments