@@ -651,6 +651,8 @@ Events mode is required for [Fast Application Notification
651
651
(FAN)] ( #connectionfan ) and [ Runtime Load Balancing
652
652
(RLB)] ( #connectionrlb ) .
653
653
654
+ This property was added in node-oracledb 2.2.
655
+
654
656
#### <a name =" propdbextendedmetadata " ></a > 3.2.4 ` oracledb.extendedMetaData `
655
657
656
658
```
@@ -671,6 +673,8 @@ additional attributes. These are listed in
671
673
672
674
This property may be overridden in an [ ` execute() ` ] ( #executeoptions ) call.
673
675
676
+ This property was added in node-oracledb 1.10.
677
+
674
678
#### <a name =" propdbisexternalauth " ></a > 3.2.5 ` oracledb.externalAuth `
675
679
676
680
```
@@ -732,7 +736,7 @@ For direct fetches (those using `execute()` option [`resultSet:
732
736
false`] ( #propexecresultset ) ), the internal buffer size will be based
733
737
on the lesser of [ ` maxRows ` ] ( #propdbmaxrows ) and ` fetchArraySize ` .
734
738
735
- The property was introduced in node-oracledb version 2. It replaces
739
+ The property was introduced in node-oracledb version 2.0. It replaces
736
740
[ ` prefetchRows ` ] ( #propdbprefetchrows ) .
737
741
738
742
##### Example
@@ -769,6 +773,8 @@ var oracledb = require('oracledb');
769
773
oracledb .fetchAsBuffer = [ oracledb .BLOB ];
770
774
```
771
775
776
+ This property was added in node-oracledb 1.13.
777
+
772
778
#### <a name =" propdbfetchasstring " ></a > 3.2.8 ` oracledb.fetchAsString `
773
779
774
780
```
@@ -881,6 +887,8 @@ readonly Number oracleClientVersion
881
887
This readonly property gives a numeric representation of the Oracle client library version which is useful in comparisons.
882
888
For version * a.b.c.d.e* , this property gives the number: ` (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e `
883
889
890
+ This property was added in node-oracledb 1.3.
891
+
884
892
##### Example
885
893
886
894
``` javascript
@@ -903,6 +911,8 @@ var oracledb = require('oracledb');
903
911
console .log (" Oracle client library version is " + oracledb .oracleClientVersionString );
904
912
```
905
913
914
+ This property was added in node-oracledb 2.2.
915
+
906
916
#### <a name =" propdboutformat " ></a > 3.2.13 ` oracledb.outFormat `
907
917
908
918
```
@@ -1052,6 +1062,8 @@ var oracledb = require('oracledb');
1052
1062
oracledb .poolPingInterval = 60 ; // seconds
1053
1063
```
1054
1064
1065
+ This property was added in node-oracledb 1.12.
1066
+
1055
1067
#### <a name =" propdbpooltimeout " ></a > 3.2.18 ` oracledb.poolTimeout `
1056
1068
1057
1069
```
@@ -1148,6 +1160,8 @@ oracledb.queueRequests = false;
1148
1160
1149
1161
See [ Connection Pool Queue] ( #connpoolqueue ) for more information.
1150
1162
1163
+ This property was added in node-oracledb 1.7.
1164
+
1151
1165
#### <a name =" propdbqueuetimeout " ></a > 3.2.22 ` oracledb.queueTimeout `
1152
1166
1153
1167
```
@@ -1171,6 +1185,8 @@ oracledb.queueTimeout = 3000; // 3 seconds
1171
1185
1172
1186
See [ Connection Pool Queue] ( #connpoolqueue ) for more information.
1173
1187
1188
+ This property was added in node-oracledb 1.7.
1189
+
1174
1190
#### <a name =" propdbstmtcachesize " ></a > 3.2.23 ` oracledb.stmtCacheSize `
1175
1191
1176
1192
```
@@ -1227,6 +1243,8 @@ var oracledb = require('oracledb');
1227
1243
console .log (" Driver version is " + oracledb .versionString );
1228
1244
```
1229
1245
1246
+ This property was added in node-oracledb 2.1.
1247
+
1230
1248
#### <a name =" propdbversionsuffix " ></a > 3.2.26 ` oracledb.versionSuffix `
1231
1249
```
1232
1250
readonly String versionSuffix
@@ -1241,6 +1259,8 @@ var oracledb = require('oracledb');
1241
1259
console .log (" Driver version suffix is " + oracledb .versionSuffix );
1242
1260
```
1243
1261
1262
+ This property was added in node-oracledb 2.1.
1263
+
1244
1264
### <a name =" oracledbmethods " ></a > 3.3 Oracledb Methods
1245
1265
1246
1266
#### <a name =" createpool " ></a > 3.3.1 ` oracledb.createPool() `
@@ -1313,6 +1333,8 @@ Connect string, or a Net Service Name from a `tnsnames.ora` file, or the
1313
1333
name of a local Oracle database instance. See
1314
1334
[ Connection Strings] ( #connectionstrings ) for examples.
1315
1335
1336
+ The ` connectionString ` alias was added in node-oracledb 2.1.
1337
+
1316
1338
###### <a name =" createpoolpoolattrsevents " ></a > 3.3.1.1.2 ` events `
1317
1339
1318
1340
```
@@ -1355,7 +1377,6 @@ proxy user is specified.
1355
1377
1356
1378
###### <a name =" createpoolpoolattrspoolalias " ></a > 3.3.1.1.5 ` poolAlias `
1357
1379
1358
- <a name =" createpoolpoolattrspoolalias " ></a >
1359
1380
```
1360
1381
String poolAlias
1361
1382
```
@@ -1368,6 +1389,8 @@ that utilize the connection pool cache, such as [`oracledb.getPool()`](#getpool)
1368
1389
1369
1390
See [ Connection Pool Cache] ( #connpoolcache ) for details and examples.
1370
1391
1392
+ This property was added in node-oracledb 1.11.
1393
+
1371
1394
###### <a name =" createpoolpoolattrspoolincrement " ></a > 3.3.1.1.6 ` poolIncrement `
1372
1395
1373
1396
```
@@ -1670,6 +1693,8 @@ See [Privileged Connections](#privconn) for more information.
1670
1693
1671
1694
Note only non-pooled connections can be privileged.
1672
1695
1696
+ This property was added in node-oracledb 2.1.
1697
+
1673
1698
###### <a name =" getconnectiondbattrsstmtcachesize " ></a > 3.3.2.1.2.7 ` stmtCacheSize `
1674
1699
1675
1700
```
@@ -1789,6 +1814,7 @@ readonly Number oracleServerVersion
1789
1814
This readonly property gives a numeric representation of the Oracle database version which is useful in comparisons.
1790
1815
For version * a.b.c.d.e* , this property gives the number: ` (100000000 * a) + (1000000 * b) + (10000 * c) + (100 * d) + e `
1791
1816
1817
+ This property was added in node-oracledb 1.3.
1792
1818
1793
1819
#### <a name =" propconnoracleserverversionstring " ></a > 4.1.5 ` connection.oracleServerVersionString `
1794
1820
@@ -1798,6 +1824,8 @@ readonly String oracleServerVersionString
1798
1824
1799
1825
This readonly property gives a string representation of the Oracle database version which is useful for display.
1800
1826
1827
+ This property was added in node-oracledb 2.2.
1828
+
1801
1829
#### <a name =" propconnstmtcachesize " ></a > 4.1.6 ` connection.stmtCacheSize `
1802
1830
1803
1831
```
@@ -1868,6 +1896,8 @@ users.
1868
1896
1869
1897
See [ Changing Passwords and Connecting with an Expired Password] ( #changingpassword ) .
1870
1898
1899
+ This method was added in node-oracledb 2.2.
1900
+
1871
1901
##### Parameters
1872
1902
1873
1903
```
@@ -1938,6 +1968,9 @@ make the connection unusable, then `close()` will drop that connection
1938
1968
from the connection pool. So a future pooled ` getConnection() ` call
1939
1969
that grows the pool will create a new, valid connection.
1940
1970
1971
+ This method was added to node-oracledb 1.9, replacing the equivalent
1972
+ alias ` connection.release() ` .
1973
+
1941
1974
##### Parameters
1942
1975
1943
1976
```
@@ -2391,8 +2424,6 @@ Each row is returned as a `data` event. Query metadata is available
2391
2424
via a ` metadata ` event. The ` end ` event indicates the end of the
2392
2425
query results.
2393
2426
2394
- Query results must be fetched to completion to avoid resource leaks.
2395
-
2396
2427
The connection must remain open until the stream is completely read.
2397
2428
2398
2429
For tuning, adjust the value of
@@ -2401,6 +2432,11 @@ option [`fetchArraySize`](#propexecfetcharraysize).
2401
2432
2402
2433
See [ Query Streaming] ( #streamingresults ) for more information.
2403
2434
2435
+ Support for Node.js version 8 Stream ` destroy() ` method was added in
2436
+ node-oracledb 2.1.
2437
+
2438
+ This method was added in node-oracledb 1.8.
2439
+
2404
2440
##### Parameters
2405
2441
2406
2442
See [ execute()] ( #execute ) .
@@ -2715,6 +2751,9 @@ before `pool.close()` is called.
2715
2751
2716
2752
If the pool is in the [ connection pool cache] ( #connpoolcache ) it will be removed from the cache.
2717
2753
2754
+ This method was added to node-oracledb 1.9, replacing the equivalent
2755
+ alias ` pool.terminate() ` .
2756
+
2718
2757
##### Parameters
2719
2758
2720
2759
```
@@ -2913,6 +2952,9 @@ for performance, adjust global attributes such as
2913
2952
2914
2953
See [ Query Streaming] ( #streamingresults ) for more information.
2915
2954
2955
+ The ` toQueryStream() ` method was added in node-oracledb 1.9. Support
2956
+ for Node.js version 8 Stream ` destroy() ` method was added in node-oracledb 2.1.
2957
+
2916
2958
## <a name =" connectionhandling " ></a > 8. Connection Handling
2917
2959
2918
2960
In applications which use connections infrequently, create a
@@ -4775,14 +4817,14 @@ Here are things to do when you see an *ORA-1000*:
4775
4817
4776
4818
- Avoid having too many incompletely processed statements open at one time:
4777
4819
4778
- - Make sure your application is handling connections and statements
4779
- in the order you expect.
4820
+ - Make sure your application is handling connections and statements
4821
+ in the order you expect.
4780
4822
4781
- - [Close ResultSets](#close) before releasing the connection.
4823
+ - [Close ResultSets](#close) before releasing the connection.
4782
4824
4783
- - If cursors are opened with ` DBMS_SQL .OPEN_CURSOR ()` in a PL/SQL
4784
- block, close them before the block returns - except for REF
4785
- CURSORs being passed back to node-oracledb.
4825
+ - If cursors are opened with ` DBMS_SQL .OPEN_CURSOR ()` in a PL/SQL
4826
+ block, close them before the block returns - except for REF
4827
+ CURSORs being passed back to node-oracledb.
4786
4828
4787
4829
- Choose the appropriate Statement Cache size. Node-oracledb has a
4788
4830
statement cache per connection. When node-oracledb internally
@@ -5542,9 +5584,9 @@ Persistent or temporary Lobs returned from the database should be
5542
5584
closed with ` lob .close ()` unless they have been automatically closed.
5543
5585
Automatic closing of returned Lobs occurs when:
5544
5586
5545
- - streaming has completed
5546
- - a stream error occurs
5547
- - the Lob was used as the source for an IN OUT bind
5587
+ - streaming has completed
5588
+ - a stream error occurs
5589
+ - the Lob was used as the source for an IN OUT bind
5548
5590
5549
5591
If you try to close a Lob being used for streaming you will get the
5550
5592
error *NJS-023: concurrent operations on a Lob are not allowed*.
@@ -6982,17 +7024,17 @@ When upgrading from node-oracledb version 1.13 to version 2.0:
6982
7024
also replaces the overloaded use of ` maxRows` for
6983
7025
[` queryStream ()` ](#querystream). To upgrade scripts:
6984
7026
6985
- - Replace the property ` prefetchRows` with ` fetchArraySize` and make
6986
- sure all values are greater than 0.
7027
+ - Replace the property ` prefetchRows` with ` fetchArraySize` and make
7028
+ sure all values are greater than 0.
6987
7029
6988
- - Tune ` fetchArraySize` instead of ` maxRows` for ` queryStream ()` .
7030
+ - Tune ` fetchArraySize` instead of ` maxRows` for ` queryStream ()` .
6989
7031
6990
- - For [direct fetches](#fetchingrows), optionally tune
6991
- ` fetchArraySize` .
7032
+ - For [direct fetches](#fetchingrows), optionally tune
7033
+ ` fetchArraySize` .
6992
7034
6993
- - For [direct fetches](#fetchingrows), optionally replace enormously
6994
- over-sized ` maxRows` values with 0, meaning an unlimited number of
6995
- rows can be returned.
7035
+ - For [direct fetches](#fetchingrows), optionally replace enormously
7036
+ over-sized ` maxRows` values with 0, meaning an unlimited number of
7037
+ rows can be returned.
6996
7038
6997
7039
- For [direct fetches](#fetchingrows) that relied on the version 1
6998
7040
default value of [` maxRows` ](#propdbmaxrows) to limit the number of
@@ -7019,9 +7061,9 @@ When upgrading from node-oracledb version 2.0 to version 2.1:
7019
7061
- If using the experimental ` _close` method with [Query
7020
7062
Streaming](#streamingresults) in Node 8 or later:
7021
7063
7022
- - Change the method name from ` _close ()` to [` destroy ()` ][92].
7023
- - Stop passing a callback.
7024
- - Optionally pass an error.
7064
+ - Change the method name from ` _close ()` to [` destroy ()` ][92].
7065
+ - Stop passing a callback.
7066
+ - Optionally pass an error.
7025
7067
7026
7068
7027
7069
[1]: https://www.npmjs.com/package/oracledb
0 commit comments