Go to file

Christopher Jones b90eeea7f9 Fix test lint warning		2016-12-01 22:49:52 +11:00
.github	Add security reporting link	2016-12-01 22:12:24 +11:00
doc	Doc updates, mostly formatting. Some cross references added. One or two tips added	2016-12-01 22:49:27 +11:00
examples	Update LOB examples	2016-12-01 22:47:16 +11:00
lib	Fixed LOB review comments	2016-12-01 22:36:27 +11:00
src	More LOB tweaks: fix a mem leak with NULL LOBs; consistently return NULL for string/buffer of EMPTY_LOB; Auto-close (where possible) the IN-bit of a LOB bind used for BIND_INOUT	2016-12-01 22:46:40 +11:00
test	Fix test lint warning	2016-12-01 22:49:52 +11:00
.editorconfig	Add editorconfig	2016-03-24 21:47:37 +11:00
.gitignore	Update LOB examples	2016-12-01 22:47:16 +11:00
.npmignore	Don't package the GitHub template files	2016-07-18 09:22:49 +10:00
CHANGELOG.md	Update CHANGELOG for 1.11	2016-08-19 13:30:06 +10:00
CONTRIBUTING.md	Add new OTN forum links for submitting feedback and discussing node-oracledb	2015-01-20 17:17:09 -08:00
INSTALL.md	Change 12.1 to 12c now that 12.2 is out	2016-12-01 22:42:20 +11:00
LICENSE.md	Whitespace cleanup	2016-03-24 17:09:53 +11:00
README.md	Add links; mention more pool features; change 12.1 -> 12c now that 12.2 is out	2016-12-01 22:41:28 +11:00
binding.gyp	Fix metaData scale and precision on AIX. Also Replace std::string.data() with std::string.c_str()	2016-08-19 13:15:31 +10:00
index.js	Added JavaScript wrapper around C++ classes. Added connection pool queue	2016-02-29 13:48:48 +11:00
package.json	Bump version to 1.12	2016-12-01 22:03:18 +11:00

README.md

node-oracledb version 1.12

About node-oracledb

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

Use node-oracledb to connect Node.js 0.12, 4, 6 and 7 to Oracle Database.

The add-on is stable, well documented, and has a comprehensive test suite.

The node-oracledb project is open source and maintained by Oracle Corp. The home page is on the Oracle Technology Network.

Node-oracledb supports:

We are actively working on supporting the best Oracle Database features, and on functionality requests from users involved in the project.

Installation

Prerequisites:

Python 2.7
C Compiler with support for C++ 11 (Xcode, gcc, Visual Studio or similar)
Oracle 11.2 or 12c client libraries. Use the small, free Oracle Instant Client "basic" and "SDK" packages if your database is remote. Or use the libraries and headers from a locally installed database such as the free Oracle XE release.

Oracle's standard client-server network compatibility applies: Oracle Client 12c can connect to Oracle Database 10.2 or greater. Oracle Client 11.2 can connect to Oracle Database 9.2 or greater.
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.

See INSTALL for details.

Examples

See the examples directory. Start with examples/select1.js.

Documentation

See Documentation for the Oracle Database Node.js Add-on.

Help

Issues and questions can be raised with the node-oracledb community on GitHub.

Changes

See CHANGELOG.

Tests

To run the test suite see test/README.

Contributing

Node-oracledb is an open source project. See CONTRIBUTING for details.

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

License

You may not use the identified files except in compliance with the Apache License, Version 2.0 (the "License.")

You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.