230 lines
14 KiB
HTML
230 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<html itemscope="itemscope" itemtype="http://schema.org/WebPage" lang="en">
|
|
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<title>node-oracledb: Node.js module for Oracle Database</title>
|
|
<link rel="stylesheet" href="base.css" type="text/css" />
|
|
<link rel="shortcut icon" type="image/ico" href="favicon.ico" />
|
|
</head>
|
|
|
|
<body>
|
|
<div class="oracleHeader">
|
|
<div class="container">
|
|
<a class="oracleLogo" href="https://www.oracle.com/">Oracle</a>
|
|
</div>
|
|
</div>
|
|
<header class="header" role="banner">
|
|
<div class="container">
|
|
<div class="headerLogoContainer">
|
|
<img class="headerLogo" alt="node-oracledb logo" src="logo.png" />
|
|
</div>
|
|
<div class="headerContent">
|
|
<h1 class="headerTitle">Node.js node-oracledb version 6.6</h1>
|
|
<nav class="headerNav" role="navigation">
|
|
<ul>
|
|
<li><a href="https://node-oracledb.readthedocs.io/en/latest/">Documentation</a></li>
|
|
<li><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html">Installation</a></li>
|
|
<li><a href="https://node-oracledb.readthedocs.io/en/latest/release_notes.html">Release Notes</a></li>
|
|
<li><a href="https://github.com/oracle/node-oracledb/discussions">Help</a></li>
|
|
<li><a href="https://github.com/oracle/node-oracledb">Source code</a></li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
</header>
|
|
|
|
<main class="mainContent" role="main">
|
|
<div class="container">
|
|
|
|
<div id="about">
|
|
<h2>About node-oracledb</h2>
|
|
|
|
<p>The node-oracledb driver for Node.js powers high performance Oracle
|
|
Database applications written in JavaScript or TypeScript.</p>
|
|
|
|
<p>Node-oracledb is a pure JavaScript module that can connect directly to
|
|
Oracle Database. Some additional features are available in an
|
|
optional 'Thick' mode that uses Oracle Client libraries to connect to the
|
|
database.</p>
|
|
|
|
<p>Node-oracledb supports <a href="#features" >basic and advanced
|
|
features</a> of Oracle Database.</p>
|
|
|
|
<p>The node-oracledb module is open source and maintained by
|
|
Oracle Corp. It is stable, well documented, and has a
|
|
comprehensive test suite.</p>
|
|
</div>
|
|
|
|
<div id="start">
|
|
<h2>Getting Started</h2>
|
|
|
|
<p>See <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#getting-started-with-node-oracledb" >Getting Started with Node-oracledb</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="installation">
|
|
<h2>Installation</h2>
|
|
|
|
<p>See <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quick-start-node-oracledb-installation" >Quick Start Node-oracledb Installation</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="examples">
|
|
<h2>Examples</h2>
|
|
|
|
<p>See the <a href="https://github.com/oracle/node-oracledb/tree/main/examples" >examples</a> directory. Start with
|
|
<a href="https://github.com/oracle/node-oracledb/blob/main/examples/example.js" >examples/example.js</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="doc">
|
|
<h2>Documentation</h2>
|
|
|
|
<p>See <a href="https://node-oracledb.readthedocs.io/en/latest/"
|
|
>Documentation for the Oracle Database Node.js Add-on</a> and <a
|
|
href="https://node-oracledb.readthedocs.io/en/latest/release_notes.html"
|
|
>Release Notes</a>.</p>
|
|
<p>You can use assistive technology products, such as screen readers, while you work with the documentation. You can also use the keyboard instead of the mouse.</p>
|
|
|
|
</div>
|
|
|
|
<div id="help">
|
|
<h2>Help</h2>
|
|
|
|
<p>Questions can be asked on <a
|
|
href="https://github.com/oracle/node-oracledb/discussions" >GitHub
|
|
Discussions</a> or <a href="https://node-oracledb.slack.com/" >Slack</a>
|
|
(<a
|
|
href="https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM"
|
|
>link to join Slack</a>). Identified issues can be raised as <a
|
|
href="https://github.com/oracle/node-oracledb/issues" >GitHub
|
|
Issues</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="testing">
|
|
<h2>Tests</h2>
|
|
|
|
<p>To run the test suite see <a href="https://github.com/oracle/node-oracledb/blob/main/test/README.md" >test/README</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="code">
|
|
<h2>Source code</h2>
|
|
|
|
<p>Source code is on <a href="https://github.com/oracle/node-oracledb" >github.com/oracle/node-oracledb</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="contrib">
|
|
<h2>Contributing</h2>
|
|
|
|
<p>Node-oracledb is an open source project. See <a href="https://github.com/oracle/node-oracledb/blob/main/CONTRIBUTING.md" >CONTRIBUTING</a> for
|
|
details.</p>
|
|
|
|
<p>Oracle gratefully acknowledges the contributions to node-oracledb that
|
|
have been made by the community.</p>
|
|
|
|
</div>
|
|
|
|
<div id="features">
|
|
<h2>Node-oracledb Features:</h2>
|
|
|
|
<ul>
|
|
<li><p><a href="https://www.npmjs.com/package/oracledb" >Install from npm</a>. Find the <a href="https://github.com/oracle/node-oracledb" >source code on GitHub</a></p></li>
|
|
<li><p><a href="https://github.com/oracle/node-oracledb/blob/main/LICENSE.txt" >Open Source: dual-licensed under the Universal Permissive License (UPL) 1.0 and Apache 2.0 licenses</a></p></li>
|
|
<li><p><a href="https://developer.oracle.com/languages/javascript/node-js.html" >Maintained by Oracle</a></p></li>
|
|
<li><p>Pure JavaScript <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#node-oracledb-thin-mode-architecture" >'Thin' mode</a> implementation by default, with an optional <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#node-oracledb-thick-mode-architecture" >'Thick' mode</a> for advanced functionality</p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/pgmstyle.html#async-await-and-node-oracledb" >Async/Await</a>, <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/pgmstyle.html#promises-and-node-oracledb" >Promises</a>, <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/pgmstyle.html#callbacks-and-node-oracledb" >Callbacks</a> and <a href="https://node-oracledb.readthedocs.io/en/latest/api_manual/connection.html#connection.queryStream" >Streams</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/sql_execution.html" >SQL Execution</a> and <a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/plsql_execution.html">PL/SQL Execution</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/batch_statement.html" >Batch Statement Execution and Bulk Loading</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#database-call-timeouts" >Call Timeouts</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/api_manual/connection.html#connection.getStatementInfo" >Statement Metadata</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/plsql_execution.html#edition-based-redefinition" >Edition-Based Redefinition</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/bind.html#ref-cursor-bind-parameters" >REF CURSORS</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/plsql_execution.html#implicit-results" >PL/SQL Implicit Results</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/lob_data.html" >Large Objects: CLOBs, BLOBs and NCLOBs as Streams, or Strings and Buffers</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/soda.html" >Oracle Database Simple Oracle Document Access (SODA)</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/json_data_type.html" >Oracle Database JSON datatype</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/sql_execution.html#fetching-char-varchar2-nchar-and-nvarchar" >NCHAR, NVARCHAR and NCLOB support</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/sql_execution.html#query-output-formats" >Query results as JavaScript objects or arrays</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/sql_execution.html#query-result-type-mapping" >Smart mapping between JavaScript and Oracle types with manual override</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/bind.html#bind-parameters-for-prepared-statements" >Data binding using JavaScript types, objects or arrays</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/objects.html" >Query and bind Oracle Database named types and collections</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/txn_management.html" >Transaction Management</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/two_phase_commit.html" >Two-Phase Commits</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connection-pooling" >Inbuilt Connection Pool with Queuing, Aliasing, Tagging, Draining, Heterogeneous and Homogeneous connections, Proxy connections and Liveness checking</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#database-resident-connection-pooling-drcp" >Database Resident Connection Pooling (DRCP)</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/api_manual/oracledb.html#getconnectiondbattrsprivilege" >Privileged Connections</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#external-authentication" >External Authentication</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#token-based-authentication" >Token Authentication</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/api_manual/connection.html#connection.ping" >Connection Health Checking</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#connecting-to-sharded-databases" >Oracle Sharding</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#changing-passwords-and-connecting-with-an-expired-password" >Password Changing</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/aq.html" >Advanced Queuing (AQ)</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/cqn.html" >Continuous Query Notification (CQN)</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/api_manual/oracledb.html#oracledb.fetchArraySize" >Array Fetches</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/tuning.html#statement-caching" >Statement Caching</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/tuning.html#client-result-caching-crc" >Client Result Caching</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/tracing.html" >End-to-end Tracing, Mid-tier Authentication, and Auditing</a></p></li>
|
|
<li><p>Oracle High Availability Features</p>
|
|
<ul>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#application-continuity" >Application Continuity</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#fast-application-notification-fan" >Fast Application Notification (FAN)</a></p></li>
|
|
<li><p><a href="https://node-oracledb.readthedocs.io/en/latest/user_guide/connection_handling.html#runtime-load-balancing-rlb" >Runtime Load Balancing (RLB)</a></p></li>
|
|
</ul></li>
|
|
<li><p>Use of Oracle Network Service infrastructure including encrypted network traffic and security features.</p></li>
|
|
<li><p>Oracle's standard cross-version interoperability allows easy upgrades and connectivity to different Oracle Database versions.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>We are actively working on supporting the best Oracle Database
|
|
features, and on functionality requests from <a
|
|
href="https://github.com/oracle/node-oracledb/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement" >users involved
|
|
in the project</a>.</p>
|
|
|
|
</div>
|
|
|
|
<div id="license">
|
|
<h2>License</h2>
|
|
|
|
<p>Copyright (c) 2015, 2024, Oracle and/or its affiliates. All rights reserved.</p>
|
|
|
|
<p>This software is dual-licensed to you under the Universal Permissive
|
|
License (UPL) 1.0 as shown at <a
|
|
href="https://oss.oracle.com/licenses/upl"
|
|
>https://oss.oracle.com/licenses/upl</a> and Apache License 2.0 as shown
|
|
at <a href="https://www.apache.org/licenses/LICENSE-2.0"
|
|
>https://www.apache.org/licenses/LICENSE-2.0</a>. You may choose either
|
|
license. </p> <p>
|
|
|
|
|
|
If you elect to accept the software under the Apache License, Version 2.0,
|
|
the following applies:
|
|
</p>
|
|
<p>
|
|
|
|
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 <a
|
|
href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>
|
|
</p>
|
|
<p>
|
|
|
|
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.</p>
|
|
</div>
|
|
|
|
</div>
|
|
</main>
|
|
</body>
|
|
|
|
</html>
|