Skip to content

Commit c2b7572

Browse files
committed
Note size limitations from recent type cast fix, and for previous casts.
1 parent b4be993 commit c2b7572

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/api.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3183,6 +3183,9 @@ the number of rows affected, for example the number of rows
31833183
inserted. For non-DML statements such as queries and PL/SQL statements,
31843184
`rowsAffected` is undefined.
31853185
3186+
Due to Node.js type limitations, the largest value shown will be
3187+
2<sup>32</sup> - 1, even if more rows were affected. Larger values will wrap.
3188+
31863189
#### <a name="executemany"></a> 4.2.7 `connection.executeMany()`
31873190
31883191
##### Prototype
@@ -3407,6 +3410,9 @@ affected by the processing of all records of the [binds
34073410
parameter](#executemanybinds). It is only present if a DML statement
34083411
was executed.
34093412
3413+
Due to Node.js type limitations, the largest value shown will be
3414+
2<sup>32</sup> - 1, even if more rows were affected. Larger values will wrap.
3415+
34103416
#### <a name="getdbobjectclass"></a> 4.2.8 `connection.getDbObjectClass()`
34113417
34123418
Callback:
@@ -3948,7 +3954,7 @@ function(Error error, Object result)
39483954
Callback function parameter | Description
39493955
----------------------------|-------------
39503956
*Error error* | If `subscribe()` succeeds, `error` is NULL. If an error occurs, then `error` contains the [error message](#errorobj).
3951-
*Object result* | For [CQN](#cqn) `oracledb.SUBSCR_NAMESPACE_DBCHANGE` subscriptions this contains a single property `regId` corresponding the value of `REGID` in the database view `USER_CHANGE_NOTIFICATION_REGS` or the value of `REG_ID` in `USER_SUBSCR_REGISTRATIONS`. For [AQ](#aq) `oracledb.SUBSCR_NAMESPACE_AQ` subscriptions, `regId`is undefined.
3957+
*Object result* | For [CQN](#cqn) `oracledb.SUBSCR_NAMESPACE_DBCHANGE` subscriptions this contains a single property `regId` corresponding the value of `REGID` in the database view `USER_CHANGE_NOTIFICATION_REGS` or the value of `REG_ID` in `USER_SUBSCR_REGISTRATIONS`. For [AQ](#aq) `oracledb.SUBSCR_NAMESPACE_AQ` subscriptions, `regId`is undefined. Due to Node.js type limitations, the largest `regId` shown will be 2<sup>32</sup> - 1. Larger values will wrap.
39523958
39533959
The `result` callback parameter was added in node-oracledb 4.0.
39543960
@@ -5569,6 +5575,9 @@ This method was added in node-oracledb 3.0.
55695575
55705576
The number of documents matching the SodaOperation criteria.
55715577
5578+
Due to Node.js type limitations, the largest `count` value will be
5579+
2<sup>32</sup> - 1, even if more rows exist. Larger values will wrap.
5580+
55725581
###### <a name="sodaoperationclassgetcursor"></a> 10.2.4.1.2.2 `sodaOperation.getCursor()`
55735582
55745583
##### Prototype
@@ -5749,6 +5758,9 @@ This method was added in node-oracledb 3.0.
57495758
57505759
The number of documents removed from the collection.
57515760
5761+
Due to Node.js type limitations, the largest `count` value will be
5762+
2<sup>32</sup> - 1, even if Oracle Database removed more rows. Larger values will wrap.
5763+
57525764
###### <a name="sodaoperationclassreplaceone"></a> 10.2.4.1.2.6 `sodaOperation.replaceOne()`
57535765
57545766
##### Prototype

0 commit comments

Comments
 (0)