Skip to content

Commit f64e989

Browse files
committed
Add some usage notes on batchErrors and dmlRowCounts
1 parent 0227ffb commit f64e989

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/api.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -2583,7 +2583,7 @@ names in the SQL statement (for 'bind by name'). Each sub-array or
25832583
sub-object should contain values for the bind variables used in the
25842584
SQL statement. At least one such record must be specified.
25852585

2586-
If a record contains fewer values then expected, NULL values will be
2586+
If a record contains fewer values than expected, NULL values will be
25872587
used. For bind by position, empty values can be specified using
25882588
syntax like `[a,,c,d]`.
25892589

@@ -2627,7 +2627,8 @@ Boolean batchErrors
26272627
```
26282628

26292629
This optional property allows invalid data records to be rejected
2630-
while still letting valid data be processed.
2630+
while still letting valid data be processed. It can only be set
2631+
*true* for INSERT, UPDATE, DELETE or MERGE statements.
26312632

26322633
When *false*, the `executeMany()` call will stop when the first error
26332634
occurs. The callback [error object](#errorobj) will be set.
@@ -2678,10 +2679,13 @@ Boolean dmlRowCounts
26782679

26792680
When *true*, this optional property enables output of the number of
26802681
rows affected by each input data record. It can only be set *true*
2681-
for DML.
2682+
for INSERT, UPDATE, DELETE or MERGE statements.
26822683

26832684
The default value is *false*.
26842685

2686+
This feature works when node-oracledb is using version 12, or later,
2687+
of the Oracle client library.
2688+
26852689
##### <a name="executemanycallback"></a> 4.2.7.4 `executeMany()`: Callback Function
26862690

26872691
###### <a name="execmanybatcherrors"></a> 4.2.7.4.1 `batchErrors`

0 commit comments

Comments
 (0)