Skip to content

Commit 4a700ad

Browse files
committed
Update table to mention maxSize and maxArraySize are ignored for IN binds
1 parent d1e270f commit 4a700ad

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

doc/api.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1630,9 +1630,9 @@ If a bind value is an object it may have the following properties:
16301630
Bind Property | Description
16311631
---------------|------------
16321632
`dir` | The direction of the bind. One of the [Oracledb Constants](#oracledbconstantsbinddir) `BIND_IN`, `BIND_INOUT`, or `BIND_OUT`.
1633-
`maxArraySize` | The number of array elements to be allocated for a PL/SQL Collection `INDEX OF` associative array OUT or IN OUT array bind variable.
1634-
`maxSize` | The maximum number of bytes that an OUT or IN OUT bind variable of type `STRING` or `BUFFER` can use to get data. The default value is 200. The maximum limit depends on the database type.
1635-
`type` | The datatype to be bound. One of the [Oracledb Constants](#oracledbconstantsbinddir) `BLOB`, `BUFFER`, `CLOB`, `CURSOR`, `DATE`, `NUMBER`, or `STRING`.
1633+
`maxArraySize` | The number of array elements to be allocated for a PL/SQL Collection `INDEX OF` associative array OUT or IN OUT array bind variable. For IN binds, the value of `maxArraySize` is ignored.
1634+
`maxSize` | The maximum number of bytes that an OUT or IN OUT bind variable of type `STRING` or `BUFFER` can use to get data. The default value is 200. The maximum limit depends on the database type, see below. When binding IN OUT, then `maxSize` refers to the size of the returned value: the input value can be smaller or bigger. For IN binds, `maxSize` is ignored.
1635+
`type` | The datatype to be bound. One of the [Oracledb Constants](#oracledbconstantsbinddir) `BLOB`, `BUFFER`, `CLOB`, `CURSOR`, `DATE`, `NUMBER`, or `STRING`. With IN OUT binds the type can be explicitly set with `type` or it will default to the type of the input data value. With OUT binds, the type defaults to `STRING` whenever `type` is not specified.
16361636
`val` | The input value or variable to be used for an IN or IN OUT bind variable.
16371637

16381638
The limit for `maxSize` when binding as a `BUFFER` type is 2000 bytes,
@@ -1644,13 +1644,6 @@ When binding Oracle LOBs, as `STRING` or `BUFFER`, the value of
16441644
`maxSize` can be much larger, see the limits
16451645
in [LOB Bind Parameters](#lobbinds).
16461646

1647-
When binding IN OUT, then `maxSize` refers to the size of the returned
1648-
value. The input value can be smaller or bigger.
1649-
1650-
With OUT binds, where the type cannot be inferred by node-oracledb
1651-
because there is no input data value, the type defaults to `STRING`
1652-
whenever `type` is not specified.
1653-
16541647
Note `CURSOR` bind variables can be used only for PL/SQL OUT binds.
16551648

16561649
##### <a name="executeoptions"></a> 4.2.5.3 `execute()`: Options

0 commit comments

Comments
 (0)