You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/src/api_manual/connection.rst
+17-7Lines changed: 17 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -115,9 +115,9 @@ The properties of a *Connection* object are listed below.
115
115
a value of ``null``. See :ref:`End-to-end Tracing, Mid-tier Authentication,
116
116
and Auditing <endtoend>`.
117
117
118
-
It is available with Oracle 12c.
118
+
It is available from Oracle 12c onwards.
119
119
120
-
.. attribute:: connection.ecId
120
+
.. attribute:: connection.ecid
121
121
122
122
.. versionadded:: 5.3
123
123
@@ -127,6 +127,11 @@ The properties of a *Connection* object are listed below.
127
127
The value is available in the ``ECID`` column of the ``V$SESSION`` view.
128
128
It is also shown in audit logs.
129
129
130
+
.. note::
131
+
132
+
This property can only be used in the node-oracledb Thick mode. See
133
+
:ref:`enablingthick`.
134
+
130
135
.. attribute:: connection.module
131
136
132
137
This write-only property is a string and it is the `module
@@ -300,7 +305,7 @@ Connection Methods
300
305
Oracle Database only in the node-oracledb Thick mode. See
301
306
:ref:`enablingthick`.
302
307
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
304
309
currently recommended to drop the connection when releasing it back to
305
310
the pool ``await connection.close({drop: true})``. See Oracle bug
306
311
29116892.
@@ -987,7 +992,7 @@ Connection Methods
987
992
988
993
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.
989
994
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:
991
996
992
997
- ``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.
993
998
- ``dbType``: one of the :ref:`Oracle Database Type Constant <oracledbconstantsdbtype>` values.
@@ -1358,6 +1363,11 @@ Connection Methods
1358
1363
This method returns a queue for enqueuing and dequeuing :ref:`Oracle Advanced
1359
1364
Queuing (AQ) <aq>` messages.
1360
1365
1366
+
.. note::
1367
+
1368
+
This method is only supported in the node-oracledb Thick mode. See
1369
+
:ref:`enablingthick`.
1370
+
1361
1371
The parameters of the ``connection.getQueue()`` method are:
1362
1372
1363
1373
.. _getqueueparams:
@@ -1528,8 +1538,8 @@ Connection Methods
1528
1538
- Depending on the statement type, the information object may contain:
1529
1539
1530
1540
- ``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>`.
1533
1543
1534
1544
.. method:: connection.isHealthy()
1535
1545
@@ -1575,7 +1585,7 @@ Connection Methods
1575
1585
since network or database failure may occur in the interval between
1576
1586
``ping()`` and ``execute()`` calls.
1577
1587
1578
-
Pinging requires a :ref:`round-trip <roundtrips>` to the database so
1588
+
Pinging requires a :ref:`round-trip <roundtrips>` to the database. So,
1579
1589
unnecessary ``ping()`` calls should be avoided.
1580
1590
1581
1591
If ``ping()`` returns an error, the application should close the
0 commit comments