Skip to content

Commit 6837c4b

Browse files
committed
Documentation and test updates
1 parent 8626243 commit 6837c4b

File tree

9 files changed

+232
-157
lines changed

9 files changed

+232
-157
lines changed

doc/src/api_manual/connection.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@ The properties of a *Connection* object are listed below.
115115
a value of ``null``. See :ref:`End-to-end Tracing, Mid-tier Authentication,
116116
and Auditing <endtoend>`.
117117

118-
It is available with Oracle 12c.
118+
It is available from Oracle 12c onwards.
119119

120-
.. attribute:: connection.ecId
120+
.. attribute:: connection.ecid
121121

122122
.. versionadded:: 5.3
123123

@@ -127,6 +127,11 @@ The properties of a *Connection* object are listed below.
127127
The value is available in the ``ECID`` column of the ``V$SESSION`` view.
128128
It is also shown in audit logs.
129129

130+
.. note::
131+
132+
This property can only be used in the node-oracledb Thick mode. See
133+
:ref:`enablingthick`.
134+
130135
.. attribute:: connection.module
131136

132137
This write-only property is a string and it is the `module
@@ -300,7 +305,7 @@ Connection Methods
300305
Oracle Database only in the node-oracledb Thick mode. See
301306
:ref:`enablingthick`.
302307

303-
If you use use ``break()`` with :ref:`DRCP connections <drcp>`, it is
308+
If you use ``break()`` with :ref:`DRCP connections <drcp>`, it is
304309
currently recommended to drop the connection when releasing it back to
305310
the pool ``await connection.close({drop: true})``. See Oracle bug
306311
29116892.
@@ -987,7 +992,7 @@ Connection Methods
987992

988993
Each column’s ``name`` is always given. If the column is a :ref:`nested cursor <nestedcursors>`, then the column’s object will also contain a ``metaData`` attribute which is an array describing each column in the nested query.
989994

990-
If the :attr:`oracledb.extendedMetaData` or ``execute()`` option :ref:`extendedMetaData <propexecextendedmetadata>` are *true*, then additional information is included.
995+
Extended metadata is now always returned and includes the following information:
991996

992997
- ``byteSize``: The database byte size. This is only set for ``oracledb.DB_TYPE_VARCHAR``, ``oracledb.DB_TYPE_CHAR`` and ``oracledb.DB_TYPE_RAW`` column types.
993998
- ``dbType``: one of the :ref:`Oracle Database Type Constant <oracledbconstantsdbtype>` values.
@@ -1358,6 +1363,11 @@ Connection Methods
13581363
This method returns a queue for enqueuing and dequeuing :ref:`Oracle Advanced
13591364
Queuing (AQ) <aq>` messages.
13601365

1366+
.. note::
1367+
1368+
This method is only supported in the node-oracledb Thick mode. See
1369+
:ref:`enablingthick`.
1370+
13611371
The parameters of the ``connection.getQueue()`` method are:
13621372

13631373
.. _getqueueparams:
@@ -1528,8 +1538,8 @@ Connection Methods
15281538
- Depending on the statement type, the information object may contain:
15291539

15301540
- ``bindNames``: An array of strings corresponding to the unique names of the bind variables used in the SQL statement.
1531-
- ``metaData``: containing properties equivalent to those given by ``execute()`` :ref:`extendedMetaData <execmetadata>`. This property exists only for queries.
1532-
- ``statementType``: an integer corresponding to one of the :ref:`SQL Statement Type Constants <oracledbconstantsstmttype>`.
1541+
- ``metaData``: Contains properties equivalent to those given by ``execute()`` :ref:`metaData <execmetadata>`. This property exists only for queries.
1542+
- ``statementType``: An integer corresponding to one of the :ref:`SQL Statement Type Constants <oracledbconstantsstmttype>`.
15331543

15341544
.. method:: connection.isHealthy()
15351545

@@ -1575,7 +1585,7 @@ Connection Methods
15751585
since network or database failure may occur in the interval between
15761586
``ping()`` and ``execute()`` calls.
15771587

1578-
Pinging requires a :ref:`round-trip <roundtrips>` to the database so
1588+
Pinging requires a :ref:`round-trip <roundtrips>` to the database. So,
15791589
unnecessary ``ping()`` calls should be avoided.
15801590

15811591
If ``ping()`` returns an error, the application should close the

doc/src/api_manual/dbobject.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ The properties of a DbObject object are listed below.
6363

6464
.. attribute:: dbObject.elementTypeClass
6565

66-
This read-only property is an object.
66+
This read-only property is an object. When ``dbObject.isCollection`` is
67+
*true* and the elements in the collection refer to database objects, this
68+
property provides the type class information of the elements.
6769

6870
.. attribute:: dbObject.elementTypeName
6971

doc/src/api_manual/errors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ and ``stack`` properties.
5656

5757
When :ref:`batchErrors <executemanyoptbatcherrors>` mode in
5858
:meth:`connection.executeMany()` returns an array of Error objects
59-
in the callback result parameter, each ``offset`` property is a 0-based
59+
in the callback result parameter, each ``offset`` property is a zero-based
6060
index corresponding to the ``executeMany()`` :ref:`binds
6161
parameter <executemanybinds>` array, indicating which record could
6262
not be processed. See :ref:`Handling Data Errors <handlingbatcherrors>`.

0 commit comments

Comments
 (0)