node-oracledb/README.md

96 lines
4.2 KiB
Markdown

# node-oracledb version 3.0-dev
The node-oracledb add-on for Node.js powers high performance Oracle
Database applications.
Use node-oracledb to connect Node.js 6, 8 and 10 to Oracle Database.
Node-oracledb supports basic and advanced features of Oracle Database
and Oracle Client. See the
[homepage](https://oracle.github.io/node-oracledb/) for a list.
The node-oracledb module is open source and maintained by Oracle Corp.
It is stable, well documented, and has a comprehensive test suite.
## <a name="installation"></a> Installation
See [Getting Started with Node-oracledb][1] and [Quick Start Node-oracledb Installation][37].
## <a name="doc"></a> Documentation
See [Documentation for the Oracle Database Node.js Add-on][32] and the [CHANGELOG][33].
## <a name="examples"></a> Examples
See the [examples][30] directory. Start with
[examples/select1.js][31].
## <a name="help"></a> Help
Issues and questions can be raised with the node-oracledb community on
[GitHub][24].
## <a name="testing"></a> Tests
To run the test suite see [test/README][34].
## <a name="contrib"></a> Contributing
Node-oracledb is an open source project. See [CONTRIBUTING][35] for
details.
Oracle gratefully acknowledges the contributions to node-oracledb that
have been made by the community.
## <a name="license"></a> License
Copyright (c) 2015, 2018, 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.")
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0][36]. 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.
[1]: https://oracle.github.io/node-oracledb/doc/api.html#getstarted
[2]: https://oracle.github.io/node-oracledb/doc/api.html#asyncawaitoverview
[3]: https://oracle.github.io/node-oracledb/doc/api.html#promiseoverview
[4]: https://oracle.github.io/node-oracledb/doc/api.html#intro
[5]: https://oracle.github.io/node-oracledb/doc/api.html#querystream
[6]: https://oracle.github.io/node-oracledb/doc/api.html#sqlexecution
[7]: https://oracle.github.io/node-oracledb/doc/api.html#refcursors
[8]: https://oracle.github.io/node-oracledb/doc/api.html#lobhandling
[9]: https://oracle.github.io/node-oracledb/doc/api.html#jsondatatype
[10]: https://oracle.github.io/node-oracledb/doc/api.html#queryoutputformats
[11]: https://oracle.github.io/node-oracledb/doc/api.html#typemap
[12]: https://oracle.github.io/node-oracledb/doc/api.html#bind
[13]: https://oracle.github.io/node-oracledb/doc/api.html#transactionmgt
[14]: https://oracle.github.io/node-oracledb/doc/api.html#connpooling
[15]: https://oracle.github.io/node-oracledb/doc/api.html#drcp
[16]: https://oracle.github.io/node-oracledb/doc/api.html#extauth
[17]: https://oracle.github.io/node-oracledb/doc/api.html#propdbfetcharraysize
[18]: https://oracle.github.io/node-oracledb/doc/api.html#stmtcache
[19]: https://docs.oracle.com/database/122/ADFNS/performance-and-scalability.htm#ADFNS464
[20]: https://oracle.github.io/node-oracledb/doc/api.html#endtoend
[21]: https://oracle.github.io/node-oracledb/doc/api.html#connectionfan
[22]: https://oracle.github.io/node-oracledb/doc/api.html#connectionrlb
[23]: https://docs.oracle.com/database/122/ADFNS/high-availability.htm#ADFNS-GUID-96599425-9BDA-483C-9BA2-4A4D13013A37
[24]: https://github.com/oracle/node-oracledb/issues
[30]: https://github.com/oracle/node-oracledb/blob/master/examples
[31]: https://github.com/oracle/node-oracledb/blob/master/examples/select1.js#L35
[32]: https://oracle.github.io/node-oracledb/doc/api.html
[33]: https://github.com/oracle/node-oracledb/blob/master/CHANGELOG.md
[34]: https://github.com/oracle/node-oracledb/blob/master/test/README.md
[35]: https://github.com/oracle/node-oracledb/blob/master/CONTRIBUTING.md
[36]: http://www.apache.org/licenses/LICENSE-2.0
[37]: https://oracle.github.io/node-oracledb/INSTALL.html#quickstart
[38]: https://oracle.github.io/node-oracledb/doc/api.html#getconnectiondbattrsprivilege