1
- # node-oracledb 1.1: Documentation for the Oracle Database Node.js Driver
1
+ # node-oracledb 1.1: Documentation for the Oracle Database Node.js Add-on
2
2
3
3
* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.*
4
4
@@ -128,8 +128,7 @@ limitations under the License.
128
128
129
129
## <a name =" intro " ></a > 1. Introduction
130
130
131
- The Oracle Database Node.js driver [ * node-oracledb* ] ( https://github.com/oracle/node-oracledb )
132
- powers high performance Node.js applications.
131
+ The [ * node-oracledb* ] ( https://github.com/oracle/node-oracledb ) add-on for Node.js powers high performance Oracle Database applications.
133
132
134
133
This document shows how to use node-oracledb. The API reference is in
135
134
sections 2 - 7 and the user guide in subsequent sections.
@@ -186,14 +185,14 @@ Scripts to create Oracle's sample schemas can be found at
186
185
187
186
Unless otherwise specified, the last parameter of each method is a
188
187
callback. If an application does not pass a callback function where
189
- it is expected, then the driver throws an exception of type * Error* .
188
+ it is expected, then node-oracledb throws an exception of type * Error* .
190
189
191
190
The first parameter of the callback is an * Error* object that
192
191
contains error information if the call fails. If the call succeeds,
193
192
then the object is null.
194
193
195
194
If an invalid value is set for a property, then the * Error* object is
196
- thrown by the driver . The same is true for invalid operations on
195
+ thrown. The same is true for invalid operations on
197
196
read-only or write-only properties.
198
197
199
198
### <a name =" properror " ></a > 2.1 Error Properties
@@ -207,7 +206,7 @@ String message
207
206
The text of the error message.
208
207
209
208
The error may be a standard Oracle message with a prefix like ORA or
210
- PLS. Alternatively it may be a driver specific error prefixed with
209
+ PLS. Alternatively it may be a node-oracledb specific error prefixed with
211
210
NJS or DPI.
212
211
213
212
A single line error message may look like this:
@@ -230,13 +229,13 @@ PL/SQL: Statement ignored
230
229
231
230
The * Oracledb* object is the factory class for * Pool* and * Connection* objects.
232
231
233
- The * Oracledb* object is instantiated by loading the driver :
232
+ The * Oracledb* object is instantiated by loading node-oracledb :
234
233
235
234
``` javascript
236
235
var oracledb = require (" oracledb" );
237
236
```
238
237
239
- Internally, the driver creates the * Oracledb* object as a singleton.
238
+ Internally, the add-on creates the * Oracledb* object as a singleton.
240
239
Reloading it in the same Node.js process creates a new pointer to the
241
240
same object.
242
241
@@ -481,7 +480,7 @@ Number lobPrefetchSize
481
480
482
481
Node-oracledb internally uses Oracle * LOB Locators* to manipulate long
483
482
object (LOB) data. LOB Prefetching allows LOB data to be returned
484
- early to node-oracledb when these locators are returned to the driver .
483
+ early to node-oracledb when these locators are first returned .
485
484
This is similar to the way [ row prefetching] ( #rowprefetching ) allows
486
485
for efficient use of resources and round-trips between node-oracledb
487
486
and the database.
@@ -3099,7 +3098,7 @@ By default,
3099
3098
[DML](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CNCPT2042)
3100
3099
statements are not committed in node-oracledb.
3101
3100
3102
- The driver implements [` commit ()` ](#commit) and
3101
+ The node-oracledb add-on implements [` commit ()` ](#commit) and
3103
3102
[` rollback ()` ](#rollback) methods that can be used to explicitly
3104
3103
control transactions.
3105
3104
@@ -3131,7 +3130,7 @@ Each non-pooled connection and each session in the connection pool has
3131
3130
its own cache of statements with a default size of 30. Statement
3132
3131
caching lets cursors be used without re-parsing the statement.
3133
3132
Statement caching also reduces meta data transfer costs between the
3134
- driver and the database. Performance and scalability are improved.
3133
+ node-oracledb and the database. Performance and scalability are improved.
3135
3134
3136
3135
In general, set the statement cache to the size of the working set of
3137
3136
statements being executed by the application.
@@ -3196,8 +3195,8 @@ Node-oracledb can use Oracle's
3196
3195
[National Language Support (NLS)](https://docs.oracle.com/database/121/NLSPG/toc.htm)
3197
3196
to assist in globalizing applications.
3198
3197
3199
- Node-oracledb always uses Oracle's AL32UTF8 character set internally
3200
- in the driver layer. Data will be converted between AL32UTF8 and the
3198
+ Node-oracledb always uses Oracle's AL32UTF8 character set internally.
3199
+ Data will be converted between AL32UTF8 and the
3201
3200
database character set when it is inserted into, or queried from, the
3202
3201
database. The environment variable ` NLS_LANG ` can be used to
3203
3202
configure the Oracle client language and territory only.
0 commit comments