Skip to content

Commit

Permalink
Merged with version 1.6 and reintegrated the positional binding of PL…
Browse files Browse the repository at this point in the history
…/SQL indexed tables
  • Loading branch information
Dieter Oberkofler committed Jan 31, 2016
1 parent be82dfc commit 1d40b96
Show file tree
Hide file tree
Showing 34 changed files with 1,979 additions and 881 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Change Log

## node-oracledb v1.6.0 (30 Jan 2016)

- Added support for binding PL/SQL Collection Associative Array
(Index-by) types containing numbers and strings.

- Fixed a LOB problem causing an uncaught error to be generated.

- Removed the 'close' event that was incorrectly emitted for LOB Writable
Streams. The Node.js Streams documentation specifies it only for
Readable Streams.

- Updated the LOB examples to show connection release.

- Updated README so first-time users see pre-requisites earlier.

- Extended the OS X install instructions with a way to install that doesn't
need root access for Instant Client 11.2 on El Capitan.

- Added RPATH link option when building on OS X in preparation for future client.

## node-oracledb v1.5.0 (21 Dec 2015)

- Treat Oracle Database 'Success With Info' warnings as success.
Expand Down
56 changes: 46 additions & 10 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,19 +399,18 @@ Building node-oracledb requires Xcode from the Mac App store.

### 5.2 Install Node.js

Node.js can be installed from various sources, such as via *brew*.
Download the [Node.js package](http://nodejs.org) for OS X 64-bit and install it.

```
brew install node
```
### 5.3 Install the free Oracle Instant Client 'Basic' and 'SDK' ZIPs

Set your PATH to include the *node* and *npm* binaries:
Do either of the options given in [5.3.1](#instosxICroot) or [5.3.2](#instosxICuser).

```
export PATH=/usr/local/bin:$PATH
```
### <a name="instosxICroot"></a> 5.3.1 Install Instant Client in /opt

### 5.3 Install the free Oracle Instant Client 'Basic' and 'SDK' ZIPs
This first installation option puts Instant Client in the default
location used by the node-oracledb installer. It requires root
access. If you don't want to update system directories then follow
the alternative steps in [5.3.2](#instosxICuser).

Download the free **Basic** and **SDK** ZIPs from
[Oracle Technology Network](http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html)
Expand All @@ -434,7 +433,44 @@ Link the OCI libraries into the default library path:
ln -s /opt/oracle/instantclient/{libclntsh.dylib.11.1,libnnz11.dylib,libociei.dylib} /usr/local/lib/
```

### 5.4 Install the add-on
Continue with [5.4](#instosxICaddon).

### <a name="instosxICuser"></a> 5.3.2 Install Instant Client in a user directory

This is an alternative to [5.3.1](#instosxICroot) that does not require root access.

Download the free **Basic** and **SDK** 64-bit ZIPs from
[Oracle Technology Network](http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html)
and
[install them](http://www.oracle.com/technetwork/topics/intel-macsoft-096467.html#ic_osx_inst)
into the same directory:

```
unzip instantclient-basic-macos.x64-11.2.0.4.0.zip
unzip instantclient-sdk-macos.x64-11.2.0.4.0.zip
cd instantclient_11_2
ln -s libclntsh.dylib.11.1 libclntsh.dylib
```

Link the OCI libraries into the user default library path:

```
mkdir ~/lib
ln -s $(pwd)/{libclntsh.dylib,libclntsh.dylib.11.1,libnnz11.dylib,libociei.dylib} ~/lib/
```

To allow the node-oracledb installer to find the Instant Client
libraries and headers, set the install-time variables `OCI_LIB_DIR`
and `OCI_INC_DIR` to the appropriate directories:

```
export OCI_LIB_DIR=~/lib
export OCI_INC_DIR=~/instantclient_11_2/sdk/include
```

These variables are only needed during installation.

### <a name="instosxICaddon"></a> 5.4 Install the add-on

If you are behind a firewall you may need to set your proxy, for
example:
Expand Down
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# node-oracledb version 1.5
# node-oracledb version 1.6

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

The node-oracledb add-on for Node.js powers high performance Oracle Database applications.

Expand Down Expand Up @@ -38,6 +38,23 @@ We are actively working on supporting the best Oracle Database
features, and on functionality requests from
[users involved in the project](https://github.com/oracle/node-oracledb/issues).

## <a name="installation"></a> Installation

Prerequisites:

- [Python 2.7](https://www.python.org/downloads/)
- C Compiler with support for C++ 11 (Xcode, gcc, Visual Studio or similar)
- The small, free [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-100365.html) libraries if your database is remote. Or use a locally installed database such as the free [Oracle XE](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) release
- Set `OCI_LIB_DIR` and `OCI_INC_DIR` during installation if the Oracle libraries and headers are in a non-default location

Run `npm install oracledb` to install from the [NPM registry](https://www.npmjs.com/package/oracledb).

See [INSTALL](https://github.com/oracle/node-oracledb/tree/master/INSTALL.md) for details.

## <a name="examples"></a> Examples

There are examples in the [examples](https://github.com/oracle/node-oracledb/tree/master/examples) directory.

### A simple query example:

```javascript
Expand Down Expand Up @@ -72,44 +89,29 @@ With Oracle's sample HR schema, the output is:
[ [ 60, 'IT' ], [ 90, 'Executive' ], [ 100, 'Finance' ] ]
```

## <a name="examples"></a> 2. Examples

There are examples in the [examples](https://github.com/oracle/node-oracledb/tree/master/examples) directory.

## <a name="installation"></a> 3. Installation

The basic install steps are:

- Install the small, free [Oracle Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index-100365.html) libraries if your database is remote. Or use a locally installed database such as the free [Oracle XE](http://www.oracle.com/technetwork/database/database-technologies/express-edition/overview/index.html) release.
- Run `npm install oracledb` to install from the [NPM registry](https://www.npmjs.com/package/oracledb).

See [INSTALL](https://github.com/oracle/node-oracledb/tree/master/INSTALL.md) for details.

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

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

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

See [CHANGELOG](https://github.com/oracle/node-oracledb/tree/master/CHANGELOG.md)

*Note* there were two small, backward-compatibility breaking attribute name changes in node-oracledb 0.5.

## <a name="testing"></a> 6. Testsuite
## <a name="testing"></a> Testsuite

To run the included testsuite see [test/README](https://github.com/oracle/node-oracledb/tree/master/test/README.md).

## <a name="contrib"></a> 7. Contributing
## <a name="contrib"></a> Contributing

Node-oracledb is an open source project. See
Node-oracledb is an open source project. See
[CONTRIBUTING](https://github.com/oracle/node-oracledb/tree/master/CONTRIBUTING.md)
for details.

Oracle gratefully acknowledges the contributions to node-oracledb that have been made by the community.

## <a name="license"></a> 8. License
## <a name="license"></a> License

Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.

You may not use the identified files except in compliance with the Apache
License, Version 2.0 (the "License.")
Expand Down
2 changes: 1 addition & 1 deletion binding.gyp
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"cflags_cc" : ['-fexceptions'],
"libraries" : ["-lclntsh"],
"link_settings" : {
"libraries" : ['-L<(oci_lib_dir)']
"libraries" : ['-L<(oci_lib_dir) -Wl,-rpath,<(oci_lib_dir)']
}
}
],
Expand Down
Loading

0 comments on commit 1d40b96

Please sign in to comment.