You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/api.md
+41-31Lines changed: 41 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -973,6 +973,8 @@ The default properties may be overridden by specifying new properties
973
973
in the `poolAttrs` parameter.
974
974
975
975
It is possible to add pools to the pool cache when calling `createPool()`.
976
+
This allows pools to later be accessed by name, removing the need to
977
+
pass the pool object through code.
976
978
See [Connection Pool Cache](#connpoolcache) for more details.
977
979
978
980
A pool should be terminated with the [`pool.close()`](#poolclose)
@@ -1181,12 +1183,12 @@ The following table shows the various signatures that can be used when invoking
1181
1183
1182
1184
Signature | Description
1183
1185
--------- | -----------
1184
-
oracledb.getConnection() | Gets a connection from the default pool. Returns a promise.
1185
-
oracledb.getConnection(callback) | Gets a connection from the default pool. Invokes the callback.
1186
-
oracledb.getConnection(poolAlias) | Gets a connection from the pool with the specified `poolAlias`. Returns a promise.
1187
-
oracledb.getConnection(poolAlias, callback) | Gets a connection from the pool with the specified `poolAlias`. Invokes the callback.
1188
-
oracledb.getConnection(connAttrs) | Creates a standalone, non-pooled connection. Returns a promise.
1189
-
oracledb.getConnection(connAttrs, callback) | Creates a standalone, non-pooled connection. Invokes the callback.
1186
+
`oracledb.getConnection()` | Gets a connection from the previously created default pool. Returns a promise.
1187
+
`oracledb.getConnection(callback)` | Gets a connection from the previously created default pool. Invokes the callback.
1188
+
`oracledb.getConnection(poolAlias)` | Gets a connection from the previously created pool with the specified `poolAlias`. Returns a promise.
1189
+
`oracledb.getConnection(poolAlias, callback)` | Gets a connection from the previously created pool with the specified `poolAlias`. Invokes the callback.
1190
+
`oracledb.getConnection(connAttrs)` | Creates a standalone, non-pooled connection. Returns a promise.
1191
+
`oracledb.getConnection(connAttrs, callback)` | Creates a standalone, non-pooled connection. Invokes the callback.
1190
1192
1191
1193
See [Connection Handling](#connectionhandling) for more information on
1192
1194
connections.
@@ -2132,12 +2134,12 @@ An alias for [pool.close()](#poolclose).
2132
2134
2133
2135
## <aname="resultsetclass"></a> 7. ResultSet Class
2134
2136
2135
-
Result sets allow query results to fetched from the database one at a
2137
+
Result Sets allow query results to fetched from the database one at a
2136
2138
time, or in groups of rows. They can also be converted to Readable
2137
-
Streams. Result sets enable applications to process very large data
2139
+
Streams. Result Sets enable applications to process very large data
2138
2140
sets.
2139
2141
2140
-
Result sets should also be used where the number of query rows cannot
2142
+
Result Sets should also be used where the number of query rows cannot
2141
2143
be predicted and may be larger than a sensible
2142
2144
[`maxRows`](#propdbmaxrows) size.
2143
2145
@@ -2148,9 +2150,9 @@ node-oracledb when binding as type [`CURSOR`](#oracledbconstantsnodbtype) to a
2148
2150
PL/SQL REF CURSOR bind parameter.
2149
2151
2150
2152
The value of [`prefetchRows`](#propdbprefetchrows) can be adjusted to
2151
-
tune the performance of result sets.
2153
+
tune the performance of Result Sets.
2152
2154
2153
-
See [ResultSet Handling](#resultsethandling) for more information on result sets.
2155
+
See [ResultSet Handling](#resultsethandling) for more information on Result Sets.
0 commit comments