Skip to content

Commit fe3ec15

Browse files
committed
Standardize on "add-on" instead of "driver"
1 parent 5f6ea61 commit fe3ec15

File tree

4 files changed

+22
-23
lines changed

4 files changed

+22
-23
lines changed

INSTALL.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ limitations under the License.
2727

2828
## <a name="overview"></a> 1. Overview
2929

30-
The Oracle Database Node.js driver node-oracledb powers high performance Node.js applications.
30+
The [*node-oracledb*](https://github.com/oracle/node-oracledb) add-on for Node.js powers high performance Oracle Database applications.
3131

3232
The steps below create a Node.js installation for testing. Adjust the
3333
steps for your environment.
3434

3535
This node-oracledb release has been tested with Node 0.10 and 0.12 on
36-
64-bit Oracle Linux and Windows. The driver can also build in some
36+
64-bit Oracle Linux and Windows. The add-on can also build in some
3737
Mac OS X, 32-bit Linux, 32-bit Windows, Solaris and AIX environments,
3838
but these architectures have not been fully tested.
3939

@@ -111,7 +111,7 @@ If you have a [ULN](https://linux.oracle.com) subscription, you can
111111
alternatively use `yum` to install these packages from the
112112
*Oracle Software for Oracle Linux* channel for your version of Linux.
113113

114-
### 2.3 Install the driver
114+
### 2.3 Install the add-on
115115

116116
If you are behind a firewall, you may need to set your proxy, for
117117
example:
@@ -214,7 +214,7 @@ link path. Do this on Linux by creating a file
214214
location `/opt/oracle/instantclient`, and then run `ldconfig` as
215215
the root user.
216216

217-
### 3.3 Install the driver
217+
### 3.3 Install the add-on
218218

219219

220220
Tell the installer where to find Instant Client:
@@ -297,7 +297,7 @@ Set your PATH variable to include Node.js:
297297
export PATH=/opt/node-v0.12.7-linux-x64/bin:$PATH
298298
```
299299

300-
### 4.2 Install the driver
300+
### 4.2 Install the add-on
301301

302302
The installer will automatically look for Oracle libraries and headers under
303303
`$ORACLE_HOME`, see
@@ -400,7 +400,7 @@ To run applications, you will need to set the link path:
400400
export DYLD_LIBRARY_PATH=/opt/oracle/instantclient:$DYLD_LIBRARY_PATH
401401
```
402402

403-
### 5.4 Install the driver
403+
### 5.4 Install the add-on
404404

405405
Tell the installer where to find Instant Client:
406406

@@ -499,7 +499,7 @@ Environment Variables -> System variables. If you have multiple
499499
versions of Oracle libraries installed, make sure to put the desired
500500
version first in the path.
501501

502-
### 6.4 Install the driver
502+
### 6.4 Install the add-on
503503

504504
Start Visual Studio and open a Developer Command Prompt within it.
505505
(If you instead decide to use a command shell outside Visual Studio, then

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
## <a name="about"></a> 1. About node-oracledb
44

5-
The Oracle Database Node.js driver powers high performance
6-
Node.js applications.
5+
The node-oracledb add-on for Node.js powers high performance Oracle Database applications.
76

87
Node-oracledb connects Node.js 0.10, Node.js 0.12, and io.js to
98
Oracle Database.
@@ -88,7 +87,7 @@ See [INSTALL](https://github.com/oracle/node-oracledb/tree/master/INSTALL.md) fo
8887

8988
## <a name="doc"></a> 4. Documentation
9089

91-
See [Documentation for the Oracle Database Node.js Driver](https://github.com/oracle/node-oracledb/tree/master/doc/api.md).
90+
See [Documentation for the Oracle Database Node.js Add-on](https://github.com/oracle/node-oracledb/tree/master/doc/api.md).
9291

9392
## <a name="changes"></a> 5. Changes
9493

doc/api.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
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

134133
This document shows how to use node-oracledb. The API reference is in
135134
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
186185

187186
Unless otherwise specified, the last parameter of each method is a
188187
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*.
190189

191190
The first parameter of the callback is an *Error* object that
192191
contains error information if the call fails. If the call succeeds,
193192
then the object is null.
194193

195194
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
197196
read-only or write-only properties.
198197

199198
### <a name="properror"></a> 2.1 Error Properties
@@ -207,7 +206,7 @@ String message
207206
The text of the error message.
208207

209208
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
211210
NJS or DPI.
212211

213212
A single line error message may look like this:
@@ -230,13 +229,13 @@ PL/SQL: Statement ignored
230229

231230
The *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
236235
var 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.
240239
Reloading it in the same Node.js process creates a new pointer to the
241240
same object.
242241

@@ -481,7 +480,7 @@ Number lobPrefetchSize
481480

482481
Node-oracledb internally uses Oracle *LOB Locators* to manipulate long
483482
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.
485484
This is similar to the way [row prefetching](#rowprefetching) allows
486485
for efficient use of resources and round-trips between node-oracledb
487486
and the database.
@@ -3099,7 +3098,7 @@ By default,
30993098
[DML](https://docs.oracle.com/database/121/CNCPT/glossary.htm#CNCPT2042)
31003099
statements 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
31043103
control transactions.
31053104
@@ -3131,7 +3130,7 @@ Each non-pooled connection and each session in the connection pool has
31313130
its own cache of statements with a default size of 30. Statement
31323131
caching lets cursors be used without re-parsing the statement.
31333132
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.
31353134
31363135
In general, set the statement cache to the size of the working set of
31373136
statements 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)
31973196
to 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
32013200
database character set when it is inserted into, or queried from, the
32023201
database. The environment variable `NLS_LANG` can be used to
32033202
configure the Oracle client language and territory only.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"plugin",
1818
"library",
1919
"driver",
20+
"add-on",
2021
"extension",
2122
"binding",
2223
"interface",

0 commit comments

Comments
 (0)