Update documentation and readthedocs config file to build successfully due to a change in readthedoc specs

This commit is contained in:
Sharad Chandran R 2023-10-06 22:17:54 +05:30
parent 89331a58e7
commit c19ff7560e
3 changed files with 43 additions and 1 deletions

16
.readthedocs.yaml Normal file
View File

@ -0,0 +1,16 @@
# required
version: 2
build:
os: ubuntu-20.04
tools:
python: "3.9"
# Build documentation in the doc/src directory with Sphinx
sphinx:
configuration: doc/src/conf.py
# declare Python requirements required to build docs
python:
install:
- requirements: doc/requirements.txt

View File

@ -36,7 +36,7 @@ Thin Mode Changes
which is null.
#) Fixed bug which caused a cursor leak while repeatedly executing a SQL
statement that fails with an NJS- prefixed error.
statement that fails with an NJS-prefixed error.
#) Ensure that the database port is passed as a number to the network connection.
See `Issue #1600 <https://github.com/oracle/node-oracledb/issues/1600>`__

View File

@ -4,6 +4,32 @@
Upgrading to the Latest node-oracledb Releases
**********************************************
.. _upgradev61v62:
Upgrading from node-oracledb 6.1 to 6.2
=======================================
- Review the :ref:`releasenotes` and take advantage of new features.
- With the new :ref:`SODA <sodaoverview>` features in node-oracledb Thick
mode:
- You can now fetch all the current indexes from a SODA collection using the
new :meth:`sodaCollection.listIndexes()` method.
- You can disable modification of SODA documents by other connections using
the new :meth:`sodaOperation.lock()` method.
- Using the new :ref:`binaryDir <odbinitoracleclientattrsopts>` property in
node-oracledb Thick mode, you can now specify the directory that is added to
the start of the default search path used by
:meth:`~oracledb.initOracleClient()` to load the
:ref:`Thick mode <enablingthick>` binary module.
- Using the new :attr:`~dbObject.packageName` property in
:ref:`DbObject class <dbobjectclass>`, you can identify the name of the
package if the type refers to a PL/SQL type.
.. _upgradev60v61:
Upgrading from node-oracledb 6.0 to 6.1