Merge with tag 0.5

Signed-off-by: Richard Natal <[email protected]>

Author: Bigous

CHANGELOG.md

@@ -0,0 +1,89 @@
+# Change Log
+
+## node-oracledb v0.5.0 (5 May 2015)
+
+- Changed the `isAutoCommit` attribute name to `autoCommit`.
+
+- Changed the `isExternalAuth` attribute name to `externalAuth`.
+
+- Fixed outBinds array counting to not give empty array entries for IN binds.
+
+- Added support for DML RETURNING bind variables.
+
+- Rectified the error message for invalid type properties.
+
+## node-oracledb v0.4.2 (28 Mar 2015)
+
+- node-oracledb is now officially installable from https://www.npmjs.com/package/oracledb
+
+- Added metadata support. Query column names are now provided in the `execute()` callback result object.
+
+- Require a more recent version of Node.js 0.10.
+
+- Changed the default Instant Client directory on AIX from /opt/oracle/instantclient_12_1 to /opt/oracle/instantclient.
+
+## node-oracledb v0.4.1 (13 Mar 2015)
+
+- Added support for External Authentication.
+
+- The `isAutoCommit` flags now works with query execution. This is useful in cases where multiple DML statements are executed followed by a SELECT statement. This can be used to avoid a round trip to the database that an explicit call to `commit()` would add.
+
+- Added AIX build support to package.json.
+
+- Improved errors messages when setting out of range property values.
+
+- Fixed a bug: When `terminate()` of a connection pool fails because connections have not yet been closed, subsequent use of `release()` to close those connections no longer gives an error "ORA-24550: Signal Received".
+
+## node-oracledb v0.3.1 (16 Feb 2015)
+
+- Added Windows build configuration.
+
+- Added Database Resident Connection Pooling (DRCP) support.
+
+- Made an explicit connection `release()` do a rollback, to be consistent with the implicit release behavior.
+
+- Made install on Linux look for Oracle libraries in a search order.
+
+- Added RPATH support on Linux.
+
+- Changed default Oracle Instant client paths to /opt/oracle/instantclient and C:\oracle\instantclient
+
+- Added a compile error message "Oracle 11.2 or later client libraries are required for building" if attempting to build with older Oracle client libraries.
+
+- Fixed setting the `isAutoCommit` property.
+
+- Fixed a crash using pooled connections on Windows.
+
+- Fixed a crash querying object types.
+
+- Fixed a crash doing a release after a failed terminate. (The Pool is still unusable - this will be fixed later)
+
+## node-oracledb v0.2.4 (20 Jan 2015 - initial release)
+
+**Initial Features include**:
+
+- SQL and PL/SQL Execution
+
+- Binding using JavaScript objects or arrays
+
+- Query results as JavaScript objects or array
+
+- Conversion between JavaScript and Oracle types
+
+- Transaction Management
+
+- Connection Pooling
+
+- Statement Caching
+
+- Client Result Caching
+
+- End-to-end tracing
+
+- High Availability Features
+
+  - Fast Application Notification (FAN)
+
+  - Runtime Load Balancing (RLB)
+
+  - Transparent Application Failover (TAF)

INSTALL.md

@@ -27,6 +27,8 @@ limitations under the License.
 
 ## <a name="overview"></a> 1. Overview
 
+The Oracle Database Node.js driver node-oracledb powers high performance Node.js applications.
+
 The steps below create a Node.js installation for testing.  Adjust the
 steps for your environment.
 
@@ -87,6 +89,8 @@ cd /opt
 tar -zxf node-v0.10.38-linux-x64.tar.gz
 ```
 
+This node-oracledb release currently works only with Node.js 0.10.
+
 Set PATH to include Node.js:
 
 ```
@@ -158,6 +162,8 @@ cd /opt
 tar -zxf node-v0.10.38-linux-x64.tar.gz
 ```
 
+This node-oracledb release currently works only with Node.js 0.10.
+
 Set PATH to include Node.js:
 
 ```
@@ -181,7 +187,8 @@ cd instantclient
 ln -s libclntsh.so.12.1 libclntsh.so
 ```
 
-You will need `libaio` installed.
+You will need `libaio` installed.  On some platforms the package is
+called `libaio1`.
 
 To run applications, you will need to set the link path:
 
@@ -218,6 +225,9 @@ Install node-oracledb from the
 npm install oracledb
 ```
 
+If you are installing with `sudo`, you may need to use `sudo -E` to
+preserve the environment variable values.
+
 ### 3.4 Run an example program
 
 Download the
@@ -263,6 +273,8 @@ cd /opt
 tar -zxf node-v0.10.38-linux-x64.tar.gz
 ```
 
+This node-oracledb release currently works only with Node.js 0.10.
+
 Set your PATH variable to include Node.js:
 
 ```
@@ -289,6 +301,9 @@ Install node-oracledb from the
 npm install oracledb
 ```
 
+If you are installing with `sudo`, you may need to use `sudo -E` to
+preserve the environment variable values.
+
 ### 4.3 Run an example program
 
 Set `LD_LIBRARY_PATH` to the Oracle library directory.  This variable,
@@ -333,6 +348,8 @@ Node.js 0.10 can be installed from various sources, such as via *brew*.
 brew install node010
 ```
 
+This node-oracledb release currently works only with Node.js 0.10.
+
 Set your PATH to include the *node* and *npm* binaries:
 
 ```
@@ -381,6 +398,9 @@ Install node-oracledb from the
 npm install oracledb
 ```
 
+If you are installing with `sudo`, you may need to use `sudo -E` to
+preserve the environment variable values.
+
 ### 5.5 Run an example program
 
 Download the
@@ -433,11 +453,11 @@ Install the 64-bit Node.js 0.10 MSI (e.g. node-v0.10.38-x64.msi) from
 [nodejs.org](http://nodejs.org/download/).  Make sure the option to
 add the Node and npm directories to the path is selected.
 
-Node-oracledb 0.4 will not build with Node.js 0.12.
+This node-oracledb release currently works only with Node.js 0.10.
 
 ### 6.3 Install the free Oracle Instant Client ZIPs
 
-Skip this step if you already have Oracle Database or full Oracle client on your machine.
+Skip this step if you already have Oracle Database or the full Oracle client on your machine.
 
 Download the free 'Basic' and 'SDK' ZIP files from
 [Oracle Technology Network](http://www.oracle.com/technetwork/topics/winx64soft-089540.html).
@@ -560,6 +580,9 @@ This is useful if you will need to upgrade Oracle Instant Client RPMs
 to a new major or minor version (for example from 11.2 to 12.1)
 without re-installing node-oracledb.
 
+If you are installing with `sudo`, you may need to use `sudo -E` to
+preserve the environment variable values.
+
 ### Forcing RPATH
 
 If you want to force using rpath when installing node-oracledb on

README.md

@@ -1,11 +1,11 @@
-# node-oracledb version 0.4
+# node-oracledb version 0.5
 
 ## <a name="about"></a> 1. About node-oracledb
 
 The Oracle Database Node.js driver powers high performance
 Node.js applications.
 
-Node-oracledb 0.4 supports basic and advanced Oracle features, including:
+Node-oracledb 0.5 supports basic and advanced Oracle features, including:
 
 - SQL and PL/SQL Execution
 - Query results as JavaScript objects or array 
@@ -23,7 +23,7 @@ Node-oracledb 0.4 supports basic and advanced Oracle features, including:
   - [Runtime Load Balancing](http://docs.oracle.com/database/121/ADFNS/adfns_perf_scale.htm#ADFNS515) (RLB)
   - [Transparent Application Failover](http://docs.oracle.com/database/121/ADFNS/adfns_avail.htm#ADFNS534) (TAF)
 
-Node-oracledb 0.4 is a preview release.  We are actively working on
+Node-oracledb 0.5 is a preview release.  We are actively working on
 adding features including LOB support and batch fetching / streaming
 of large query result sets.
 
@@ -92,13 +92,19 @@ See [INSTALL](INSTALL.md) for details.
 
 See [Documentation for the Oracle Database Node.js Driver](doc/api.md)
 
-## <a name="contrib"></a> 4. Contributing
+## <a name="changes"></a> 4. Changes
+
+See [CHANGELOG](CHANGELOG.md)
+
+*Note* there were two small, backward-compatibility breaking attribute name changes in node-oracledb 0.5.
+
+## <a name="contrib"></a> 5. Contributing
 
 Node-oracledb is an open source project. See 
 [CONTRIBUTING](CONTRIBUTING.md)
 for details.
 
-## <a name="license"></a> 5. Licence
+## <a name="license"></a> 6. Licence
 
 Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.