Skip to content

Commit 885de16

Browse files
committed
Introduce fetchArraySize to replace prefetchRows for query fetch tuning
1 parent 1b717b8 commit 885de16

24 files changed

+837
-435
lines changed

INSTALL.md

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,27 @@ This node-oracledb release has been tested with Node 4, 6 and 8 on
4949
some 32-bit Linux, 32-bit Windows, Solaris and AIX environments, but
5050
these architectures have not been fully tested.
5151

52-
*Note*: Installation has improved significantly in node-oracledb 2.x.
53-
Pre-built binaries are now available for some combinations of
54-
platforms and Node.js versions. And if you need to build your own
55-
binary, the Oracle header files and node-oracledb environment variables
56-
`OCI_INC_DIR` and `OCI_LIB_DIR` are no longer required. At run time,
57-
Oracle client libraries must now always be in the default library
52+
#### Changes in node-oracledb 2.x
53+
54+
In node-oracledb 2.x, pre-built binaries are available as a
55+
convenience for common architectures. Note the operating systems and
56+
versions of Node.js that the binaries are compatibile with will change
57+
as the Node.js project evolves, and are not guaranteed.
58+
59+
Building from source code has improved significantly in 2.x The Oracle
60+
header files and node-oracledb environment variables `OCI_INC_DIR` and
61+
`OCI_LIB_DIR` are no longer required.
62+
63+
The Oracle client libraries must now always be in the default library
5864
search path, such as `PATH` (on Windows) or `LD_LIBRARY_PATH` (on
5965
Linux) or in `~/lib` (on macOS) because they are dynamically loaded at
6066
run time. 'Rpath' linking is no longer performed on Linux or macOS.
6167

68+
Node-oracledb 2.x binaries will run with any of the Oracle client
69+
11.2, 12.1 or 12.2 libraries without needing recompilation. Note the
70+
available Oracle functionality will vary with different Oracle Client
71+
versions.
72+
6273
## <a name="quickstart"></a> 2. Quick Start Node-oracledb Installation
6374

6475
Many users will be able to use pre-built node-oracledb binaries:
@@ -92,7 +103,7 @@ from source code:
92103

93104
See [Troubleshooting Node-oracledb Installation Problems](#troubleshooting) if you have issues.
94105

95-
## 3. <a name="instructions"></a> Node-oracledb Installation Instructions
106+
## <a name="instructions"></a> 3. Node-oracledb Installation Instructions
96107

97108
#### Which Instructions to Follow
98109

@@ -112,7 +123,7 @@ Another OS with Oracle Database 11.2 or 12c, or client libraries available | Upd
112123
Source code from GitHub | Start with [Node-oracledb Installation from GitHub](#github) and then follow relevant platform instructions.
113124
I don't have internet access | [Node-oracledb Installation Without Internet Access](#offline)
114125

115-
### 3.1 <a name="prerequisites"></a> Prerequisites
126+
### <a name="prerequisites"></a> 3.1 Prerequisites
116127

117128
All installations need:
118129

@@ -172,6 +183,9 @@ Questions and issues can be posted as [GitHub Issues][10].
172183

173184
Review the generic [prerequisites](#prerequisites).
174185

186+
Pre-built binaries were built on Oracle Linux 6 and will require a
187+
compatible glibc.
188+
175189
If source code is being compiled you need:
176190

177191
- GCC 4.7 (or later) because compiling for Node 4 (or later) requires
@@ -221,7 +235,7 @@ npm install oracledb
221235
```
222236

223237
Available pre-built node-oracledb binaries can been seen on the
224-
[releases][41] page.
238+
[releases][41] page. They were built on Oracle Linux 6.
225239

226240
If a pre-built binary is successfully installed but isn't usable
227241
because it depends on a different glibc version, uninstall
@@ -328,6 +342,9 @@ Questions and issues can be posted as [GitHub Issues][10].
328342

329343
Review the generic [prerequisites](#prerequisites).
330344

345+
Pre-built binaries were built on Oracle Linux 6 and will require a
346+
compatible glibc.
347+
331348
If source code is being compiled you need:
332349

333350
- GCC 4.7 (or later) because compiling for Node 4 (or later) requires
@@ -377,7 +394,7 @@ npm install oracledb
377394
```
378395

379396
Available pre-built node-oracledb binaries can been seen on the
380-
[releases][41] page.
397+
[releases][41] page. They were built on Oracle Linux 6.
381398

382399
If a pre-built binary is successfully installed but isn't usable
383400
because it depends on a different glibc version, uninstall
@@ -612,6 +629,8 @@ Questions and issues can be posted as [GitHub Issues][10].
612629

613630
Review the generic [prerequisites](#prerequisites).
614631

632+
The pre-built binaries were built on macOS Sierra, 10.12.6.
633+
615634
Oracle Instant Client libraries are required on macOS. There is no
616635
native Oracle Database for macOS but one can easily be run in a Linux
617636
virtual machine, see [The Easiest Way to Install Oracle Database on
@@ -738,6 +757,9 @@ Questions and issues can be posted as [GitHub Issues][10].
738757

739758
Review the generic [prerequisites](#prerequisites).
740759

760+
The pre-built binaries were built with Visual Studio 2015 and require
761+
the matching [redistributable][27].
762+
741763
You may need Administrator privileges to set environment variables or
742764
install software.
743765

@@ -845,7 +867,7 @@ variable `TNS_ADMIN` to that directory name.
845867

846868
The `PATH` variable needs to include the appropriate VS Redistributable:
847869
- Oracle client 12.2 requires the [Visual Studio 2013 Redistributable][27].
848-
- Oracle client 12.1 requires the [Visual Studio 2010 Redistributable][28].
870+
- Oracle client 12.1 requires the [Visual Studio 2010 Redistributable][27].
849871
- Oracle client 11.2 requires the [Visual Studio 2005 Redistributable][29].
850872

851873
You can also find out the version required by locating the library
@@ -888,6 +910,9 @@ Questions and issues can be posted as [GitHub Issues][10].
888910

889911
Review the generic [prerequisites](#prerequisites).
890912

913+
The pre-built binaries were built with Visual Studio 2015 and require
914+
the matching [redistributable][27].
915+
891916
The Oracle software can be either a database home or a full Oracle
892917
client installation. Make sure that `PATH` contains the correct
893918
binary directory, for example `C:\oracle\product\12.2.0\dbhome_1\bin`.
@@ -1265,10 +1290,10 @@ Build node-oracledb from source code using the [Node-oracledb
12651290
Installation Instructions](#instructions) for your operating system
12661291
but change the install command to download from [GitHub][1] instead of
12671292
from [npmjs.com][4]. For example, to install the code corresponding
1268-
to the tag 'v1.13.1', use the command:
1293+
to the GitHub tag 'v2.0.15', use the command:
12691294

12701295
```
1271-
npm install oracle/node-oracledb#v1.13.1
1296+
npm install oracle/node-oracledb#v2.0.15
12721297
```
12731298

12741299
#### 3.11.2 Installing GitHub clones and zip files
@@ -1400,16 +1425,12 @@ Some companies block access to github.com so `npm install oracledb`
14001425
will fail to download binaries, as will installing source code from
14011426
GitHub with `npm install oracle/node-oracledb.git#v2.0.15`.
14021427

1403-
14041428
To install node-oracledb in this case, compile the source code
14051429
included in the npm package:
14061430

1407-
- Use `npm install -verbose oracledb` and locate the URL it uses to
1408-
download the node-oracledb package, for example
1431+
- Download the node-oracledb package from npm, for example
14091432
`https://registry.npmjs.org/oracledb/-/oracledb-2.0.15.tgz`
14101433

1411-
Download and save the package.
1412-
14131434
- Create a directory such as `oracledb_build` and extract the package
14141435
inside it:
14151436

@@ -1569,9 +1590,8 @@ If `require('oracledb')` fails:
15691590
[24]: https://docs.oracle.com/database/122/NTCLI/toc.htm
15701591
[25]: http://www.oracle.com/technetwork/topics/winx64soft-089540.html
15711592
[26]: http://www.oracle.com/technetwork/topics/winsoft-085727.html
1572-
[27]: https://support.microsoft.com/en-us/kb/2977003#bookmark-vs2013
1573-
[28]: https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads#bookmark-vs2010
1574-
[29]: https://www.microsoft.com/en-us/download/details.aspx?id=18471
1593+
[27]: https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
1594+
[29]: https://www.microsoft.com/en-us/download/details.aspx?id=3387
15751595
[30]: http://www.oracle.com/technetwork/topics/aix5lsoft-098883.html
15761596
[31]: http://www.oracle.com/technetwork/topics/solx8664soft-097204.html
15771597
[32]: https://github.com/oracle/node-oracledb/blob/node-oracledb-v1/INSTALL.md

0 commit comments

Comments
 (0)