| 1 | # node-oracledb version 5.4.0
|
| 2 |
|
| 3 | The node-oracledb add-on for Node.js powers high performance Oracle Database
|
| 4 | applications. Applications can be written in TypeScript, or directly in
|
| 5 | JavaScript.
|
| 6 |
|
| 7 | Use node-oracledb 5.4.0 to connect Node.js 14, or later, to Oracle Database.
|
| 8 | Older versions of node-oracledb may work with older versions of Node.js.
|
| 9 |
|
| 10 | Node-oracledb supports basic and advanced features of Oracle Database
|
| 11 | and Oracle Client. See the [homepage][4] for a list.
|
| 12 |
|
| 13 | The node-oracledb module is open source and maintained by Oracle Corp.
|
| 14 | It is stable, well documented, and has a comprehensive test suite.
|
| 15 |
|
| 16 | ## <a name="installation"></a> Installation
|
| 17 |
|
| 18 | See [Getting Started with Node-oracledb][1] and [Quick Start Node-oracledb Installation][2].
|
| 19 |
|
| 20 | ## <a name="doc"></a> Documentation
|
| 21 |
|
| 22 | See [Documentation for the Oracle Database Node.js Add-on][32] and the [CHANGELOG][33].
|
| 23 |
|
| 24 | ## <a name="examples"></a> Examples
|
| 25 |
|
| 26 | See the [examples][30] directory. Start with [examples/example.js][31].
|
| 27 |
|
| 28 | ## <a name="help"></a> Help
|
| 29 |
|
| 30 | Issues and questions about node-oracledb can be posted on [GitHub][3] or
|
| 31 | [Slack][5] ([link to join Slack][6]).
|
| 32 |
|
| 33 | ## <a name="testing"></a> Tests
|
| 34 |
|
| 35 | To run the test suite see [test/README][34].
|
| 36 |
|
| 37 | ## <a name="contrib"></a> Contributing
|
| 38 |
|
| 39 | Node-oracledb is an open source project. See [CONTRIBUTING][35] for
|
| 40 | details.
|
| 41 |
|
| 42 | Oracle gratefully acknowledges the contributions to node-oracledb that
|
| 43 | have been made by the community.
|
| 44 |
|
| 45 | ## <a name="license"></a> License
|
| 46 |
|
| 47 | Copyright (c) 2015, 2022, Oracle and/or its affiliates.
|
| 48 |
|
| 49 | You may not use the identified files except in compliance with the Apache
|
| 50 | License, Version 2.0 (the "License.")
|
| 51 |
|
| 52 | You may obtain a copy of the License at
|
| 53 | [http://www.apache.org/licenses/LICENSE-2.0][36]. Unless required by
|
| 54 | applicable law or agreed to in writing, software distributed under the
|
| 55 | License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
| 56 | CONDITIONS OF ANY KIND, either express or implied.
|
| 57 |
|
| 58 | See the License for the specific language governing permissions and
|
| 59 | limitations under the License.
|
| 60 |
|
| 61 | Developers choosing to distribute a binary implementation of this project are
|
| 62 | responsible for obtaining and providing all required licenses and copyright
|
| 63 | notices for the third-party code used in order to ensure compliance with their
|
| 64 | respective open source licenses.
|
| 65 |
|
| 66 | [1]: https://oracle.github.io/node-oracledb/doc/api.html#getstarted
|
| 67 | [2]: https://oracle.github.io/node-oracledb/INSTALL.html#quickstart
|
| 68 | [3]: https://github.com/oracle/node-oracledb/issues
|
| 69 | [4]: https://oracle.github.io/node-oracledb
|
| 70 | [5]: https://node-oracledb.slack.com/
|
| 71 | [6]: https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM
|
| 72 | [30]: https://github.com/oracle/node-oracledb/blob/main/examples
|
| 73 | [31]: https://github.com/oracle/node-oracledb/blob/main/examples/example.js#L32
|
| 74 | [32]: https://oracle.github.io/node-oracledb/doc/api.html
|
| 75 | [33]: https://github.com/oracle/node-oracledb/blob/main/CHANGELOG.md
|
| 76 | [34]: https://github.com/oracle/node-oracledb/blob/main/test/README.md
|
| 77 | [35]: https://github.com/oracle/node-oracledb/blob/main/CONTRIBUTING.md
|
| 78 | [36]: http://www.apache.org/licenses/LICENSE-2.0
|