oracledb 5.5.0 → 6.0.0

package/LICENSE.txt

@@ -1,218 +1,18 @@
--------------------------------------------------------------------------------
-node-oracledb
--------------------------------------------------------------------------------
+Copyright (c) 2015, 2023 Oracle and/or its affiliates.
 
-You may not use the identified files except in compliance with the
-Apache License, Version 2.0 (the "License.")
+This software is dual-licensed to you under the Universal Permissive License
+(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+either license.
 
-You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0.  A copy of the license is
-also reproduced below.
-
-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.
-
-
-                            Apache License
-                      Version 2.0, January 2004
-                   http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
+If you elect to accept the software under the Apache License, Version 2.0,
+the following applies:
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   https://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,
@@ -220,20 +20,6 @@ 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.
 
--------------------------------------------------------------------------------
-ODPI-C
--------------------------------------------------------------------------------
-
-Copyright (c) 2016, 2022 Oracle and/or its affiliates.
-
-This program is free software: you can modify it and/or redistribute it under
-the terms of:
-
-(i)  the Universal Permissive License v 1.0 or at your option, any
-     later version (<http://oss.oracle.com/licenses/upl>); and/or
-
-(ii) the Apache License v 2.0. (<http://www.apache.org/licenses/LICENSE-2.0>)
-
 
 The Universal Permissive License (UPL), Version 1.0
 ===================================================

package/NOTICE.txt

@@ -1 +1 @@
-Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+Copyright (c) 2015, 2023, Oracle and/or its affiliates.

package/README.md

@@ -1,11 +1,12 @@
-# node-oracledb version 5.5.0
+# node-oracledb version 6.0.0
 
 The node-oracledb add-on for Node.js powers high performance Oracle Database
 applications.  Applications can be written in TypeScript, or directly in
 JavaScript.
 
-Use node-oracledb 5.5.0 to connect Node.js 14, or later, to Oracle Database.
-Older versions of node-oracledb may work with older versions of Node.js.
+Use node-oracledb 6.0.0 to connect Node.js 14.6, or later, to Oracle
+Database.  Older versions of node-oracledb may work with older versions of
+Node.js.
 
 Node-oracledb supports basic and advanced features of Oracle Database
 and Oracle Client.  See the [homepage][4] for a list.
@@ -13,19 +14,19 @@ and Oracle Client.  See the [homepage][4] 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
+## Installation
 
 See [Getting Started with Node-oracledb][1] and [Quick Start Node-oracledb Installation][2].
 
-## <a name="doc"></a> Documentation
+## Documentation
 
 See [Documentation for the Oracle Database Node.js Add-on][32] and the [CHANGELOG][33].
 
-## <a name="examples"></a> Examples
+## Examples
 
 See the [examples][30] directory.  Start with [examples/example.js][31].
 
-## <a name="help"></a> Help
+## Help
 
 Issues and questions about node-oracledb can be posted on [GitHub][3] or
 [Slack][5] ([link to join Slack][6]).
@@ -34,45 +35,52 @@ Issues and questions about node-oracledb can be posted on [GitHub][3] or
 
 To run the test suite see [test/README][34].
 
-## <a name="contrib"></a> Contributing
+## Contributing
 
-Node-oracledb is an open source project. See [CONTRIBUTING][35] for
-details.
+This project welcomes contributions from the community. Before submitting a
+pull request, please [review our contribution guide][35].
 
-Oracle gratefully acknowledges the contributions to node-oracledb that
-have been made by the community.
+Oracle gratefully acknowledges the contributions to node-oracledb that have
+been made by the community.
 
-## <a name="license"></a> License
+## Security
 
-Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+Please consult the [security guide](./SECURITY.md) for our responsible security
+vulnerability disclosure process.
 
-You may not use the identified files except in compliance with the Apache
-License, Version 2.0 (the "License.")
+## License
 
+Copyright (c) 2015, 2023, Oracle and/or its affiliates.
+
+This software is dual-licensed to you under the Universal Permissive License
+(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+either license.
+
+If you elect to accept the software under the Apache License, Version 2.0,
+the following applies:
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with 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.
 
+   https://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.
 
-Developers choosing to distribute a binary implementation of this project are
-responsible for obtaining and providing all required licenses and copyright
-notices for the third-party code used in order to ensure compliance with their
-respective open source licenses.
-
-[1]: https://oracle.github.io/node-oracledb/doc/api.html#getstarted
-[2]: https://oracle.github.io/node-oracledb/INSTALL.html#quickstart
+[1]: https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#getstarted
+[2]: https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart
 [3]: https://github.com/oracle/node-oracledb/issues
 [4]: https://oracle.github.io/node-oracledb
 [5]: https://node-oracledb.slack.com/
 [6]: https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM
 [30]: https://github.com/oracle/node-oracledb/blob/main/examples
-[31]: https://github.com/oracle/node-oracledb/blob/main/examples/example.js#L32
-[32]: https://oracle.github.io/node-oracledb/doc/api.html
+[31]: https://github.com/oracle/node-oracledb/blob/main/examples/example.js
+[32]: https://node-oracledb.readthedocs.io/en/latest/
 [33]: https://github.com/oracle/node-oracledb/blob/main/CHANGELOG.md
 [34]: https://github.com/oracle/node-oracledb/blob/main/test/README.md
 [35]: https://github.com/oracle/node-oracledb/blob/main/CONTRIBUTING.md
-[36]: http://www.apache.org/licenses/LICENSE-2.0

package/SECURITY.md

@@ -0,0 +1,38 @@
+# Reporting security vulnerabilities
+
+Oracle values the independent security research community and believes that
+responsible disclosure of security vulnerabilities helps us ensure the security
+and privacy of all our users.
+
+Please do NOT raise a GitHub Issue to report a security vulnerability. If you
+believe you have found a security vulnerability, please submit a report to
+[secalert_us@oracle.com][1] preferably with a proof of concept. Please review
+some additional information on [how to report security vulnerabilities to Oracle][2].
+We encourage people who contact Oracle Security to use email encryption using
+[our encryption key][3].
+
+We ask that you do not use other channels or contact the project maintainers
+directly.
+
+Non-vulnerability related security issues including ideas for new or improved
+security features are welcome on GitHub Issues.
+
+## Security updates, alerts and bulletins
+
+Security updates will be released on a regular cadence. Many of our projects
+will typically release security fixes in conjunction with the
+[Oracle Critical Patch Update][3] program. Additional
+information, including past advisories, is available on our [security alerts][4]
+page.
+
+## Security-related information
+
+We will provide security related information such as a threat model, considerations
+for secure use, or any known security issues in our documentation. Please note
+that labs and sample code are intended to demonstrate a concept and may not be
+sufficiently hardened for production use.
+
+[1]: mailto:secalert_us@oracle.com
+[2]: https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html
+[3]: https://www.oracle.com/security-alerts/encryptionkey.html
+[4]: https://www.oracle.com/security-alerts/

package/build/Release/oracledb-6.0.0-darwin-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-6.0.0-darwin-x64.node v16.20.0 860028aa05a0de50f81df433ab99d4f907f9a99a ccbaddf0256153ecfa6702c6ae1a4e5003e3775e Tue, 16 May 2023 11:28:59 GMT

package/build/Release/oracledb-6.0.0-js-buildinfo.txt

@@ -0,0 +1 @@
+860028aa05a0de50f81df433ab99d4f907f9a99a

package/build/Release/oracledb-6.0.0-linux-arm64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-6.0.0-linux-arm64.node v16.20.0 860028aa05a0de50f81df433ab99d4f907f9a99a ccbaddf0256153ecfa6702c6ae1a4e5003e3775e Tue, 16 May 2023 11:56:16 GMT

package/build/Release/oracledb-6.0.0-linux-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-6.0.0-linux-x64.node v16.20.0 860028aa05a0de50f81df433ab99d4f907f9a99a ccbaddf0256153ecfa6702c6ae1a4e5003e3775e Tue, 16 May 2023 13:29:42 GMT

package/build/Release/oracledb-6.0.0-win32-x64.node-buildinfo.txt

@@ -0,0 +1 @@
+oracledb-6.0.0-win32-x64.node v16.19.0 860028aa05a0de50f81df433ab99d4f907f9a99a ccbaddf0256153ecfa6702c6ae1a4e5003e3775e Tue, 16 May 2023 13:40:01 GMT

package/examples/README.md

@@ -0,0 +1,113 @@
+# Node-oracledb Examples
+
+The directory in node-oracledb's [Github repository](https://github.com/oracle/node-oracledb/tree/main/examples) contains a lot of [node-oracledb](https://www.npmjs.com/package/oracledb)
+examples.  Documentation is
+[here](https://node-oracledb.readthedocs.io/en/latest/).
+
+To run the examples:
+
+- [Install node-oracledb](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart).
+
+- Ensure that you navigate to the `examples` directory in your terminal window
+  or IDE, where you are running the samples.
+
+- Review `dbconfig.js`.  In your terminal window or IDE, set the environment
+  variables.  For example, set `NODE_ORACLEDB_PASSWORD` to the value of your
+  database password.
+
+- Review the samples and then run them individually.  For example, to see what
+  the file `example.js` does, use:
+
+  ```
+  node example.js
+  ```
+
+- After running examples, the demonstration objects can be dropped with
+  `demodrop.js`:
+
+  ```
+  node demodrop.js
+  ```
+
+Many examples can be run in either node-oracledb Thin (the default) or Thick
+modes.  Thin mode is a pure JavaScript implementation of node-oracledb.
+Setting the environment variable `NODE_ORACLEDB_DRIVER_MODE` to `'thick'` will
+make examples use Thick mode.
+
+## Example Overview
+
+If this is your first time with node-oracledb, start with
+[`example.js`](example.js).
+
+File Name                                                 | Description
+----------------------------------------------------------|----------------------------------------------------------------------------------
+[`aqmulti.js`](aqmulti.js)                                | Oracle Advanced Queuing (AQ) example passing multiple messages
+[`aqobject.js`](aqobject.js)                              | Oracle Advanced Queuing (AQ) example passing an Oracle Database object
+[`aqoptions.js`](aqoptions.js)                            | Oracle Advanced Queuing (AQ) example setting options and message attributes
+[`aqraw.js`](aqraw.js)                                    | Basic Oracle Advanced Queuing (AQ) example passing text messages
+[`blobhttp.js`](blobhttp.js)                              | Simple web app that streams an image
+[`calltimeout.js`](calltimeout.js)                        | Shows how to cancel a SQL statement if it doesn't complete in a specified time
+[`connect.js`](connect.js)                                | Basic example for creating a standalone (non-pooled) connection
+[`connectionpool.js`](connectionpool.js)                  | Basic example creating a pool of connections
+[`cqn1.js`](cqn1.js)                                      | Basic Continuous Query Notification (CQN) example
+[`cqn2.js`](cqn2.js)                                      | Continuous Query Notification with notification grouping
+[`date_timestamp1.js`](date_timestamp1.js)                | Show some basic DATE and TIMESTAMP behaviors
+[`date_timestamp2.js`](date_timestamp2.js)                | Show some DATE and TIMESTAMP behaviors with timezones
+[`dbconfig.js`](dbconfig.js)                              | Common file used by examples for setting connection credentials
+[`dbmsoutputgetline.js`](dbmsoutputgetline.js)            | Show fetching DBMS_OUTPUT by binding buffers
+[`dbmsoutputpipe.js`](dbmsoutputpipe.js)                  | Show fetching DBMS_OUTPUT by using a pipelined table
+[`demodrop.js`](demodrop.js)                              | Drops the schema objects created by the examples
+[`demosetup.js`](demosetup.js)                            | Used to create common schema objects for the examples
+[`dmlrupd.js`](dmlrupd.js)                                | Example of DML RETURNING where multiple rows are matched
+[`em_batcherrors.js`](em_batcherrors.js)                  | `executeMany()` example showing handling data errors
+[`em_dmlreturn1.js`](em_dmlreturn1.js)                    | `executeMany()` example of DML RETURNING that returns single values
+[`em_dmlreturn2.js`](em_dmlreturn2.js)                    | `executeMany()` example of DML RETURNING that returns multiple values
+[`em_insert1.js`](em_insert1.js)                          | Array DML example using `executeMany()` with bind-by-name syntax
+[`em_insert2.js`](em_insert2.js)                          | Array DML example using `executeMany()` with bind by position
+[`em_plsql.js`](em_plsql.js)                              | `executeMany()` example calling PL/SQL multiple times with one call
+[`em_rowcounts.js`](em_rowcounts.js)                      | `executeMany()` example showing how to find the number of rows affected by each input row
+[`endtoend.js`](endtoend.js)                              | Example showing setting tracing attributes
+[`example.js`](example.js)                                | Basic example showing creating a table, inserting multiple rows, and querying rows
+[`impres.js`](impres.js)                                  | Shows PL/SQL 'Implict Results' returning multiple query results from PL/SQL code.
+[`insert1.js`](insert1.js)                                | Basic example creating a table and inserting data.  Shows DDL and DML
+[`insert2.js`](insert2.js)                                | Basic example showing auto commit behavior
+[`lastinsertid.js`](lastinsertid.js)                      | Shows inserting a row and getting its ROWID.
+[`lobbinds.js`](lobbinds.js)                              | Demonstrates how to bind and query LOBs
+[`lobinsert1.js`](lobinsert1.js)                          | Shows inserting a file into a CLOB column
+[`lobinsert2.js`](lobinsert2.js)                          | Inserts text into a CLOB column using the RETURNING INTO method.
+[`lobinserttemp.js`](lobinserttemp.js)                    | Writes data to a Temporary CLOB and then inserts it into the database
+[`lobplsqltemp.js`](lobplsqltemp.js)                      | Streams data into a Temporary CLOB and then passes it to PL/SQL
+[`lobselect.js`](lobselect.js)                            | Shows basic, non-streaming CLOB and BLOB queries
+[`lobstream1.js`](lobstream1.js)                          | Shows how to stream LOBs to files
+[`lobstream2.js`](lobstream2.js)                          | Shows using Stream data events to fetch a CLOB
+[`lowercasecolumns.js`](lowercasecolumns.js)              | Shows how a type handler can convert column names to lower case
+[`metadata.js`](metadata.js)                              | Shows the metadata available after executing SELECT statements
+[`plsqlarray.js`](plsqlarray.js)                          | Examples of binding PL/SQL "INDEX BY" tables
+[`plsqlfunc.js`](plsqlfunc.js)                            | How to call a PL/SQL function
+[`plsqlproc.js`](plsqlproc.js)                            | How to call a PL/SQL procedure
+[`plsqlrecord.js`](plsqlrecord.js)                        | Shows binding of PL/SQL RECORDS
+[`plsqlvarrayrecord.js`](plsqlvarrayrecord.js)            | Shows binding a VARRAY of RECORD in PL/SQL
+[`raw.js`](raw.js)                                        | Shows using a Buffer to insert and select a RAW
+[`refcursor.js`](refcursor.js)                            | Shows using a ResultSet to fetch rows from a REF CURSOR
+[`refcursortoquerystream.js`](refcursortoquerystream.js)  | Converts a REF CURSOR returned from `execute()` to a query stream.
+[`resultset1.js`](resultset1.js)                          | Executes a query and uses a ResultSet to fetch rows with `getRow()`
+[`resultset2.js`](resultset2.js)                          | Executes a query and uses a ResultSet to fetch batches of rows with `getRows()`
+[`resultsettoquerystream.js`](resultsettoquerystream.js)  | Converts a ResultSet returned from `execute()` into a Readable Stream.
+[`rowlimit.js`](rowlimit.js)                              | Shows ways to limit the number of records fetched by queries
+[`select1.js`](select1.js)                                | Executes a basic query without using a connection pool or ResultSet
+[`select2.js`](select2.js)                                | Executes queries to show array and object output formats
+[`selectgeometry.js`](selectgeometry.js)                  | Insert and query Oracle Spatial geometries
+[`selectjson.js`](selectjson.js)                          | Shows some JSON features of Oracle Database 21c
+[`selectjsonblob.js`](selectjsonblob.js)                  | Shows how to use a BLOB as a JSON column store
+[`selectobject.js`](selectobject.js)                      | Insert and query a named Oracle database object
+[`selectnestedcursor.js`](selectnestedcursor.js)          | Shows selecting from a nested cursor
+[`selectstream.js`](selectstream.js)                      | Executes a basic query using a Readable Stream
+[`selectvarray.js`](selectvarray.js)                      | Shows inserting and selecting from a VARRAY column
+[`sessionfixup.js`](sessionfixup.js)                      | Shows a pooled connection callback to efficiently set session state
+[`sessiontagging1.js`](sessiontagging1.js)                | Simple pooled connection tagging for setting session state
+[`sessiontagging2.js`](sessiontagging2.js)                | More complex example of pooled connection tagging for setting session state
+[`soda1.js`](soda1.js)                                    | Basic Simple Oracle Document Access (SODA) example
+[`typehandlerdate.js`](typehandlerdate.js)                | Show how a type handler can format a queried date in a locale-specific way
+[`typehandlernum.js`](typehandlernum.js)                  | Show how a type handler can format a queried number in a locale-specific way
+[`version.js`](version.js)                                | Shows the node-oracledb version attributes
+[`webapp.js`](webapp.js)                                  | A simple web application using a connection pool

package/examples/dbconfig.js

@@ -0,0 +1,100 @@
+/* Copyright (c) 2015, 2023, Oracle and/or its affiliates. */
+
+/******************************************************************************
+ *
+ * This software is dual-licensed to you under the Universal Permissive License
+ * (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
+ * 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
+ * either license.
+ *
+ * If you elect to accept the software under the Apache License, Version 2.0,
+ * the following applies:
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://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.
+ *
+ * NAME
+ *   dbconfig.js
+ *
+ * DESCRIPTION
+ *   Holds the credentials used by node-oracledb examples to connect
+ *   to the database.  Production applications should consider using
+ *   External Authentication to avoid hard coded credentials.
+ *
+ *   To create a database user see
+ *   https://blogs.oracle.com/sql/post/how-to-create-users-grant-them-privileges-and-remove-them-in-oracle-database
+ *
+ *   Applications can set the connectString value to an Easy Connect
+ *   string, or a Net Service Name from a tnsnames.ora file or
+ *   external naming service, or it can be the name of a local Oracle
+ *   database instance.
+ *
+ *   If node-oracledb is linked with Instant Client, then an Easy
+ *   Connect string is generally appropriate.  The basic syntax is:
+ *
+ *     [//]host_name[:port][/service_name][:server_type][/instance_name]
+ *
+ *   Commonly just the host_name and service_name are needed
+ *   e.g. "localhost/orclpdb1" or "example.com/XEPDB1"
+ *
+ *   The Easy Connect syntax was enhanced in Oracle Database 19c to
+ *   allow more options, refer to the documentation:
+ *   https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-B0437826-43C1-49EC-A94D-B650B6A4A6EE
+ *
+ *   If using a tnsnames.ora file, the file can be in a default
+ *   location such as $ORACLE_HOME/network/admin/tnsnames.ora or
+ *   /etc/tnsnames.ora.  Alternatively set the TNS_ADMIN environment
+ *   variable and put the file in $TNS_ADMIN/tnsnames.ora.
+ *
+ *   If connectString is not specified, the empty string "" is used
+ *   which indicates to connect to the local, default database.
+ *
+ *   External Authentication can be used by setting the optional
+ *   property externalAuth to true.  External Authentication allows
+ *   applications to use an external password store such as Oracle
+ *   Wallet so passwords do not need to be hard coded into the
+ *   application.  The user and password properties for connecting or
+ *   creating a pool should not be set when externalAuth is true.
+ *
+ * TROUBLESHOOTING
+ *   Errors like:
+ *     ORA-12541: TNS:no listener
+ *   or
+ *     ORA-12154: TNS:could not resolve the connect identifier specified
+ *   indicate connectString is invalid.
+ *
+ *   The error:
+ *     ORA-12514: TNS:listener does not currently know of requested in connect descriptor
+ *   indicates connectString is invalid.  You are reaching a computer
+ *   with Oracle installed but the service name isn't known.
+ *   Use 'lsnrctl services' on the database server to find available services
+ *
+ *****************************************************************************/
+
+module.exports = {
+  user          : process.env.NODE_ORACLEDB_USER,
+
+  // Get the password from the environment variable
+  // NODE_ORACLEDB_PASSWORD.  The password could also be a hard coded
+  // string (not recommended), or it could be prompted for.
+  // Alternatively use External Authentication so that no password is
+  // needed.
+  password      : process.env.NODE_ORACLEDB_PASSWORD,
+
+  // For information on connection strings see:
+  // https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connectionstrings
+  connectString : process.env.NODE_ORACLEDB_CONNECTIONSTRING,
+
+  // Setting externalAuth is optional.  It defaults to false.  See:
+  // https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#extauth
+  externalAuth  : process.env.NODE_ORACLEDB_EXTERNALAUTH ? true : false,
+};