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
22
33* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.*
44
@@ -128,8 +128,7 @@ limitations under the License.
128128
129129## <a name =" intro " ></a > 1. Introduction
130130
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.
133132
134133This document shows how to use node-oracledb. The API reference is in
135134sections 2 - 7 and the user guide in subsequent sections.
@@ -186,14 +185,14 @@ Scripts to create Oracle's sample schemas can be found at
186185
187186Unless otherwise specified, the last parameter of each method is a
188187callback. 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* .
190189
191190The first parameter of the callback is an * Error* object that
192191contains error information if the call fails. If the call succeeds,
193192then the object is null.
194193
195194If 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
197196read-only or write-only properties.
198197
199198### <a name =" properror " ></a > 2.1 Error Properties
@@ -207,7 +206,7 @@ String message
207206The text of the error message.
208207
209208The 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
211210NJS or DPI.
212211
213212A single line error message may look like this:
@@ -230,13 +229,13 @@ PL/SQL: Statement ignored
230229
231230The * Oracledb* object is the factory class for * Pool* and * Connection* objects.
232231
233- The * Oracledb* object is instantiated by loading the driver :
232+ The * Oracledb* object is instantiated by loading node-oracledb :
234233
235234``` javascript
236235var oracledb = require (" oracledb" );
237236```
238237
239- Internally, the driver creates the * Oracledb* object as a singleton.
238+ Internally, the add-on creates the * Oracledb* object as a singleton.
240239Reloading it in the same Node.js process creates a new pointer to the
241240same object.
242241
@@ -481,7 +480,7 @@ Number lobPrefetchSize
481480
482481Node-oracledb internally uses Oracle * LOB Locators* to manipulate long
483482object (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 .
485484This is similar to the way [ row prefetching] ( #rowprefetching ) allows
486485for efficient use of resources and round-trips between node-oracledb
487486and the database.
@@ -3099,7 +3098,7 @@ By default,
30993098[DML](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CNCPT2042)
31003099statements are not committed in node-oracledb.
31013100
3102- The driver implements [` commit ()` ](#commit) and
3101+ The node-oracledb add-on implements [` commit ()` ](#commit) and
31033102[` rollback ()` ](#rollback) methods that can be used to explicitly
31043103control transactions.
31053104
@@ -3131,7 +3130,7 @@ Each non-pooled connection and each session in the connection pool has
31313130its own cache of statements with a default size of 30. Statement
31323131caching lets cursors be used without re-parsing the statement.
31333132Statement 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.
31353134
31363135In general, set the statement cache to the size of the working set of
31373136statements being executed by the application.
@@ -3196,8 +3195,8 @@ Node-oracledb can use Oracle's
31963195[National Language Support (NLS)](https://docs.oracle.com/database/121/NLSPG/toc.htm)
31973196to assist in globalizing applications.
31983197
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
32013200database character set when it is inserted into, or queried from, the
32023201database. The environment variable ` NLS_LANG ` can be used to
32033202configure the Oracle client language and territory only.
0 commit comments