Skip to content

Commit 6a76715

Browse files
committed
Tidy-up the Windows install section and remove focus on Instant Client
1 parent 46a5476 commit 6a76715

File tree

1 file changed

+34
-25
lines changed

1 file changed

+34
-25
lines changed

INSTALL.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ limitations under the License.
2222
3. [Node-oracledb Installation on Linux with Instant Client ZIP files](#instzip)
2323
4. [Node-oracledb Installation on Linux with a Local Database](#instoh)
2424
5. [Node-oracledb Installation on OS X with Instant Client](#instosx)
25-
6. [Node-oracledb Installation on Windows with Instant Client](#instwin)
25+
6. [Node-oracledb Installation on Windows](#instwin)
2626
7. [Advanced installation on Linux](#linuxadv)
2727

2828
## <a name="overview"></a> 1. Overview
@@ -452,17 +452,20 @@ To run a database on OS X, one option is to use VirtualBox,
452452
see
453453
[The Easiest Way to Enable Oracle Database Application Development on Mac OS X](https://blogs.oracle.com/opal/entry/the_easiest_way_to_enable).
454454

455-
## <a name="instwin"></a> 6. Node-oracledb Installation on Windows with Instant Client
455+
## <a name="instwin"></a> 6. Node-oracledb Installation on Windows
456456

457457
### 6.1 Install required tools
458458

459-
Install a Microsoft C/C++ compiler.
459+
Install a C/C++ build environment such as Microsoft Visual
460+
Studio 2013. Compilers supported by Oracle libraries are found in
461+
Oracle documentation for each version, for example
462+
[Oracle Database Client Quick Installation Guide 12c Release 1 (12.1) for Microsoft Windows x64 (64-Bit)](https://docs.oracle.com/database/121/NXCQI/toc.htm#NXCQI108).
460463

461464
Install Git 1.9 from [git-scm.com](http://git-scm.com/download/win).
462-
While installing, select the 'Use Git from the Windows Command Prompt'
463-
in the 'Adjusting your PATH environment' dialog. Select the option to
464-
"Checkout Windows-style, commit UNIX-style line endings" in the
465-
"Configuring the line ending conversions" dialog.
465+
While installing, select the "*Use Git from the Windows Command
466+
Prompt*" in the "*Adjusting your PATH environment*" dialog. Also
467+
select the option to "*Checkout Windows-style, commit UNIX-style line
468+
endings*" in the "*Configuring the line ending conversions*" dialog.
466469

467470
Install the Python 2.7 MSI from
468471
[www.python.org](https://www.python.org/downloads). Select the option
@@ -478,65 +481,71 @@ git clone https://github.com/oracle/node-oracledb.git
478481

479482
Install the 64 bit Node.js MSI from [nodejs.org](http://nodejs.org/download/)
480483

481-
Add the *node* and *node-gyp* directories to the path:
484+
Add the Node.js directory to the path:
482485

483486
```
484-
set PATH=%PATH%;"C:\Program Files\nodejs
485-
set PATH=%PATH%;"C:\Program Files\nodejs\node_modules\npm\bin\node-gyp-bin
487+
set PATH=%PATH%;C:\Program Files\nodejs
486488
```
487489

488490
### 6.4 Install the free Oracle Instant Client ZIPs
489491

490-
Download the free 'Basic' and 'SDK' RPMs from
492+
Skip this step if you already have Oracle Database on your machine.
493+
494+
Download the free 'Basic' and 'SDK' ZIP files from
491495
[Oracle Technology Network](http://www.oracle.com/technetwork/topics/winx64soft-089540.html).
492496

493497
Extract `instantclient_basic-windows.x64-12.1.0.2.0.zip` and
494-
`instantclient_sdk-windows.x64-12.1.0.2.0.zip` to
495-
`C:\instantclient_12_1`.
498+
`instantclient_sdk-windows.x64-12.1.0.2.0.zip` to the same location.
499+
500+
Optionally rename the resulting directory to `C:\oracle\instantclient`
496501

497502
Update the path:
498503

499504
```
500-
set PATH=C:\instantclient_12_1\;%PATH%
505+
set PATH=C:\oracle\instantclient\;%PATH%
501506
```
502507

503508
### 6.5 Install the driver
504509

505-
506-
Tell the installer where to find the Oracle libraries and headers:
510+
If you have Instant Client in a location that is *not*
511+
`C:\oracle\instantclient`, then tell the installer where to find the
512+
Oracle libraries and headers:
507513

508514
```
509-
set OCI_INC_DIR=C:\instantclient_12_1\sdk\include
510-
set OCI_LIB_DIR=C:\instantclient_12_1\sdk\lib\msvc
515+
set OCI_LIB_DIR=D:\instantclient_12_1\sdk\lib\msvc
516+
set OCI_INC_DIR=D:\instantclient_12_1\sdk\include
511517
```
512518

513-
If you are installing with a local database, try:
519+
If you are installing with a local database, use:
514520

515521
```
516-
OCI_INC_DIR=C:\oracle\product\12.1.0\dbhome_1\oci\include
517-
OCI_LIB_DIR=C:\oracle\product\12.1.0\dbhome_1\oci\lib\msvc
522+
set OCI_LIB_DIR=C:\oracle\product\12.1.0\dbhome_1\oci\lib\msvc
523+
set OCI_INC_DIR=C:\oracle\product\12.1.0\dbhome_1\oci\include
518524
```
519525

520526
Run the installer:
521527

522528
```
523529
cd node-oracledb
524-
node-gyp rebuild
530+
npm install -g
525531
```
526532

527533
### 6.6 Run an example program
528534

535+
Set `NODE_PATH` to include the newly installed node-oracledb driver:
529536

530-
Set `NODE_PATH` to include the newly installed node-oracledb driver.
537+
```
538+
set NODE_PATH=%USERPROFILE%\AppData\Roaming\npm\node_modules
539+
```
531540

532541
Edit `dbconfig.js` in the `examples` directory and set the database
533-
credentials to your environment.
542+
credentials to your environment:
534543

535544
```
536545
module.exports = {
537546
user : "hr",
538547
password : "welcome",
539-
connectString : "myothermachine/orcl"
548+
connectString : "localhost/XE"
540549
};
541550
```
542551

0 commit comments

Comments
 (0)