Skip to content

Commit c19ff75

Browse files
committed
Update documentation and readthedocs config file to build successfully due to a change in readthedoc specs
1 parent 89331a5 commit c19ff75

File tree

3 files changed

+43
-1
lines changed

3 files changed

+43
-1
lines changed

.readthedocs.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# required
2+
version: 2
3+
4+
build:
5+
os: ubuntu-20.04
6+
tools:
7+
python: "3.9"
8+
9+
# Build documentation in the doc/src directory with Sphinx
10+
sphinx:
11+
configuration: doc/src/conf.py
12+
13+
# declare Python requirements required to build docs
14+
python:
15+
install:
16+
- requirements: doc/requirements.txt

doc/src/release_notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Thin Mode Changes
3636
which is null.
3737

3838
#) Fixed bug which caused a cursor leak while repeatedly executing a SQL
39-
statement that fails with an NJS- prefixed error.
39+
statement that fails with an NJS-prefixed error.
4040

4141
#) Ensure that the database port is passed as a number to the network connection.
4242
See `Issue #1600 <https://github.com/oracle/node-oracledb/issues/1600>`__

doc/src/user_guide/migrate.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,32 @@
44
Upgrading to the Latest node-oracledb Releases
55
**********************************************
66

7+
.. _upgradev61v62:
8+
9+
Upgrading from node-oracledb 6.1 to 6.2
10+
=======================================
11+
12+
- Review the :ref:`releasenotes` and take advantage of new features.
13+
14+
- With the new :ref:`SODA <sodaoverview>` features in node-oracledb Thick
15+
mode:
16+
17+
- You can now fetch all the current indexes from a SODA collection using the
18+
new :meth:`sodaCollection.listIndexes()` method.
19+
20+
- You can disable modification of SODA documents by other connections using
21+
the new :meth:`sodaOperation.lock()` method.
22+
23+
- Using the new :ref:`binaryDir <odbinitoracleclientattrsopts>` property in
24+
node-oracledb Thick mode, you can now specify the directory that is added to
25+
the start of the default search path used by
26+
:meth:`~oracledb.initOracleClient()` to load the
27+
:ref:`Thick mode <enablingthick>` binary module.
28+
29+
- Using the new :attr:`~dbObject.packageName` property in
30+
:ref:`DbObject class <dbobjectclass>`, you can identify the name of the
31+
package if the type refers to a PL/SQL type.
32+
733
.. _upgradev60v61:
834

935
Upgrading from node-oracledb 6.0 to 6.1

0 commit comments

Comments
 (0)