Skip to content

Commit 64a889d

Browse files
committed
Add more notes about version changes
1 parent 6b9cbd1 commit 64a889d

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

doc/api.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -766,15 +766,15 @@ or [`queryStream()`](#querystream) calls can override the
766766
`fetchAsBuffer` global setting by
767767
using [`fetchInfo`](#executeoptions).
768768

769+
This property was added in node-oracledb 1.13.
770+
769771
##### Example
770772

771773
```javascript
772774
var oracledb = require('oracledb');
773775
oracledb.fetchAsBuffer = [ oracledb.BLOB ];
774776
```
775777

776-
This property was added in node-oracledb 1.13.
777-
778778
#### <a name="propdbfetchasstring"></a> 3.2.8 `oracledb.fetchAsString`
779779

780780
```
@@ -904,15 +904,15 @@ readonly String oracleClientVersionString
904904

905905
This readonly property gives a string representation of the Oracle client library version which is useful for display.
906906

907+
This property was added in node-oracledb 2.2.
908+
907909
##### Example
908910

909911
```javascript
910912
var oracledb = require('oracledb');
911913
console.log("Oracle client library version is " + oracledb.oracleClientVersionString);
912914
```
913915

914-
This property was added in node-oracledb 2.2.
915-
916916
#### <a name="propdboutformat"></a> 3.2.13 `oracledb.outFormat`
917917

918918
```
@@ -943,15 +943,15 @@ This property may be overridden in
943943
an [`execute()`](#executeoptions)
944944
or [`queryStream()`](#querystream) call.
945945

946+
See [Query Output Formats](#queryoutputformats) for more information.
947+
946948
##### Example
947949

948950
```javascript
949951
var oracledb = require('oracledb');
950952
oracledb.outFormat = oracledb.ARRAY;
951953
```
952954

953-
See [Query Output Formats](#queryoutputformats) for more examples.
954-
955955
#### <a name="propdbpoolincrement"></a> 3.2.14 `oracledb.poolIncrement`
956956

957957
```
@@ -1056,14 +1056,15 @@ This property may be overridden when [creating a connection pool](#createpool).
10561056

10571057
See [Connection Pool Pinging](#connpoolpinging) for more discussion.
10581058

1059+
This property was added in node-oracledb 1.12.
1060+
10591061
##### Example
1062+
10601063
```javascript
10611064
var oracledb = require('oracledb');
10621065
oracledb.poolPingInterval = 60; // seconds
10631066
```
10641067

1065-
This property was added in node-oracledb 1.12.
1066-
10671068
#### <a name="propdbpooltimeout"></a> 3.2.18 `oracledb.poolTimeout`
10681069

10691070
```
@@ -1151,17 +1152,17 @@ The default value is *true*.
11511152

11521153
This property may be overridden when [creating a connection pool](#createpool).
11531154

1155+
See [Connection Pool Queue](#connpoolqueue) for more information.
1156+
1157+
This property was added in node-oracledb 1.7.
1158+
11541159
##### Example
11551160

11561161
```javascript
11571162
var oracledb = require('oracledb');
11581163
oracledb.queueRequests = false;
11591164
```
11601165

1161-
See [Connection Pool Queue](#connpoolqueue) for more information.
1162-
1163-
This property was added in node-oracledb 1.7.
1164-
11651166
#### <a name="propdbqueuetimeout"></a> 3.2.22 `oracledb.queueTimeout`
11661167

11671168
```
@@ -1176,17 +1177,17 @@ The default value is 60000.
11761177

11771178
This property may be overridden when [creating a connection pool](#createpool).
11781179

1180+
See [Connection Pool Queue](#connpoolqueue) for more information.
1181+
1182+
This property was added in node-oracledb 1.7.
1183+
11791184
##### Example
11801185

11811186
```javascript
11821187
var oracledb = require('oracledb');
11831188
oracledb.queueTimeout = 3000; // 3 seconds
11841189
```
11851190

1186-
See [Connection Pool Queue](#connpoolqueue) for more information.
1187-
1188-
This property was added in node-oracledb 1.7.
1189-
11901191
#### <a name="propdbstmtcachesize"></a> 3.2.23 `oracledb.stmtCacheSize`
11911192

11921193
```
@@ -1236,31 +1237,31 @@ readonly String versionString
12361237

12371238
This readonly property gives a string representation of the node-oracledb version, including the version suffix if one is present.
12381239

1240+
This property was added in node-oracledb 2.1.
1241+
12391242
##### Example
12401243

12411244
```javascript
12421245
var oracledb = require('oracledb');
12431246
console.log("Driver version is " + oracledb.versionString);
12441247
```
12451248

1246-
This property was added in node-oracledb 2.1.
1247-
12481249
#### <a name="propdbversionsuffix"></a> 3.2.26 `oracledb.versionSuffix`
12491250
```
12501251
readonly String versionSuffix
12511252
```
12521253

12531254
This readonly property gives a string representing the version suffix (e.g. "-dev" or "-beta") or an empty string if no version suffix is present.
12541255

1256+
This property was added in node-oracledb 2.1.
1257+
12551258
##### Example
12561259

12571260
```javascript
12581261
var oracledb = require('oracledb');
12591262
console.log("Driver version suffix is " + oracledb.versionSuffix);
12601263
```
12611264

1262-
This property was added in node-oracledb 2.1.
1263-
12641265
### <a name="oracledbmethods"></a> 3.3 Oracledb Methods
12651266

12661267
#### <a name="createpool"></a> 3.3.1 `oracledb.createPool()`
@@ -1670,6 +1671,8 @@ expired.
16701671

16711672
See [Changing Passwords and Connecting with an Expired Password](#changingpassword).
16721673

1674+
This property was added in node-oracledb 2.2.
1675+
16731676
###### <a name="getconnectiondbattrspassword"></a> 3.3.2.1.2.5 `password`
16741677

16751678
```

0 commit comments

Comments
 (0)