Merge doc updates from v5.5.x branch

This commit is contained in:
Christopher Jones 2023-02-21 14:59:40 +11:00
parent 3e717dedb5
commit c3f295c5ac
5 changed files with 13 additions and 16 deletions

View File

@ -1,6 +1,6 @@
# node-oracledb 6.0.0-dev Documentation for the Oracle Database Node.js Add-on
Copyright (c) 2015, 2022, Oracle and/or its affiliates.
*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

View File

@ -59,8 +59,8 @@ The properties of a *Connection* object are listed below.
identifier <https://www.oracle.com/pls/topic/lookup?ctx=dblatest
&id=GUID-8A9F1295-4360-4AC6-99A4-050C5C82E0B0>`__
for end-to-end application tracing, use with mid-tier authentication,
and with `Virtual Private Databases <https://www.oracle.com/pls/topic/lookup?
ctx=dblatest&id=GUID-89DB0C3C-A36F-4254-8C82-020F5F6DE31F>`__.
and with `Virtual Private Databases <https://www.oracle.com/pls/topic/
lookup?ctx=dblatest&id=GUID-4F37BAE5-CA2E-42AC-9CDF-EC9181671FFE>`__.
Displaying ``Connection.clientId`` will show a value of ``null``. See
:ref:`End-to-end Tracing, Mid-tier Authentication, and Auditing <endtoend>`.

View File

@ -640,8 +640,7 @@ node-oracledb `v4.0.0 <https://github.com/oracle/node-oracledb/compare/v3.1.2...
are required.
#) Fixed a crash occurring when draining the connection pool (`ODPI-C
change <https://github.com/oracle/odpi/commit/https://github.com/oracle/
odpi/commit/7666dc3208087383f7f0f5e49c1ee423cb154997>`__).
change <https://github.com/oracle/odpi/commit/7666dc3208087383f7f0f5e49c1ee423cb154997>`__).
#) Corrected ``pool.status`` to be read-only, as was documented.
@ -723,8 +722,8 @@ node-oracledb `v3.1.0 <https://github.com/oracle/node-oracledb/compare/v3.0.1...
applications where not all users will be accessing Oracle Database.
It allows code generation tools to access node-oracledb constants
without needing Oracle Client installed (see
`#983 <https://github.com/oracle/node-oracledb/issues/983>`__.
without requiring Oracle Client libraries to be installed (see
`#983 <https://github.com/oracle/node-oracledb/issues/983>`__).
Applications now have more scope to alter Oracle environment
variables referenced by the Oracle Client layer. Note it is still
@ -736,7 +735,7 @@ node-oracledb `v3.1.0 <https://github.com/oracle/node-oracledb/compare/v3.0.1...
String limited to the VARCHAR2 length.
#) Updated install processes by bundling all pre-built binaries into
the `<https://www.npmjs.com/package/oracledb package>`__, removing the
the `<https://www.npmjs.com/package/oracledb>`__ package, removing the
need for a separate binary package download from GitHub. At runtime
an appropriate binary is loaded by `require()`, if it exists,
allowing one `node_modules/oracledb` install to be usable in
@ -1010,7 +1009,7 @@ node-oracledb `v2.1.0 <https://github.com/oracle/node-oracledb/compare/v2.0.15..
- The `yum.oracle.com <http://yum.oracle.com/oracle-linux-nodejs.html>`__
Node.js RPM Packages for Oracle Linux
- The `Oracle mirror <oss.oracle.com/git/oracle>`__ of `github.com/oracle
- The `Oracle mirror <https://oss.oracle.com/git/oracle/>`__ of `github.com/oracle
<https://github.com/oracle>`__.
#) Correct the error message text when attempting to set
@ -1751,7 +1750,7 @@ node-oracledb `v1.4.0 <https://github.com/oracle/node-oracledb/compare/v1.3.0...
#) Fixed a crash when accessing Pool properties on Windows.
#) Added a run-script 'testWindows' target for Windows testing. See
`test/README.md <test/README.md>`__.
`test/README.md <https://github.com/oracle/node-oracledb/blob/v5.5.x/test/README.md>`__.
#) Fixed compilation warnings with recent compilers.

View File

@ -180,13 +180,12 @@ Guide <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-B0437826
-43C1-49EC-A94D-B650B6A4A6EE>`__ for the syntax in your version of the Oracle
Client libraries.
If you are using Oracle Client 19c, the latest `Easy Connect
If you are using Oracle Client 19c (or later), the latest `Easy Connect
Plus <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-8C85D289-
6AF3-41BC-848B-BF39D32648BA>`__ syntax allows the use of multiple hosts or
ports, along with optional entries for the wallet location, the distinguished
name of the database server, and even lets some network configuration options
be set. The technical paper `Oracle Database 21c Easy Connect Plus Configurable
Database Connection Syntax <https://download.oracle.com/ocomdocs/global/Oracle
be set. Oracle's `Technical Paper on Easy Connect Plus Syntax <https://download.oracle.com/ocomdocs/global/Oracle
-Net-21c-Easy-Connect-Plus.pdf>`__ discusses the syntax. The Easy Connect Plus
syntax means that :ref:`tnsnames.ora <tnsadmin>` or
:ref:`sqlnet.ora <tnsadmin>` files are not needed for some further common
@ -2462,8 +2461,7 @@ has more details, including when to use, and when not to use DRCP.
There are a number of Oracle Database ``V$`` views that can be used to
monitor DRCP. These are discussed in the Oracle documentation and in the
Oracle technical paper `PHP Scalability and High Availability <https://
www.oracle.com/technetwork/topics/php/php-scalability-ha-twp-128842.pdf>`__.
Oracle technical paper `Extreme Oracle Database Connection Scalability with Database Resident Connection Pooling (DRCP) <https://www.oracle.com/docs/tech/drcp-technical-brief.pdf>`__.
This paper also gives more detail on configuring DRCP.
.. _privconn:

View File

@ -22,7 +22,7 @@ database schema. By setting ``clientId`` to the applications
authenticated user name, the database is aware of who the actual end
user is. This can, for example, be used by Oracle `Virtual Private
Database <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-
89DB0C3C-A36F-4254-8C82-020F5F6DE31F>`__ policies to automatically restrict
4F37BAE5-CA2E-42AC-9CDF-EC9181671FFE>`__ policies to automatically restrict
data access by that user.
The attributes are set on a :attr:`connection <oracledb.connectionClass>`