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/oracledb.rst
+215Lines changed: 215 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -821,6 +821,29 @@ Each of the configuration properties is described below.
821
821
constoracledb=require('oracledb');
822
822
oracledb.dbObjectAsPojo=false;
823
823
824
+
.. attribute:: oracledb.driverName
825
+
826
+
.. versionadded:: 6.7
827
+
828
+
This property is a string that specifies the name of the driver used by
829
+
the client to connect to Oracle Database. This is equivalent to the value
830
+
in the ``CLIENT_DRIVER`` column of the ``V$SESSION_CONNECT_INFO`` view.
831
+
832
+
This property may be overridden when creating a
833
+
:meth:`standalone connection <oracledb.getConnection()>` or a
834
+
:meth:`connection pool <oracledb.createPool()>`.
835
+
836
+
.. note::
837
+
838
+
This property can only be used in the node-oracledb Thin mode.
839
+
840
+
**Example**
841
+
842
+
.. code-block:: javascript
843
+
844
+
constoracledb=require('oracledb');
845
+
oracledb.driverName='mydriver';
846
+
824
847
.. attribute:: oracledb.edition
825
848
826
849
.. versionadded:: 2.2
@@ -1177,6 +1200,29 @@ Each of the configuration properties is described below.
1177
1200
constoracledb=require('oracledb');
1178
1201
oracledb.lobPrefetchSize=16384;
1179
1202
1203
+
.. attribute:: oracledb.machine
1204
+
1205
+
.. versionadded:: 6.7
1206
+
1207
+
This property is a string that specifies the name of the host machine
1208
+
where the connection originates. This is equivalent to the value in the
1209
+
``MACHINE`` column of the ``V$SESSION`` view.
1210
+
1211
+
This property may be overridden when creating a
1212
+
:meth:`standalone connection <oracledb.getConnection()>` or a
1213
+
:meth:`connection pool <oracledb.createPool()>`.
1214
+
1215
+
.. note::
1216
+
1217
+
This property can only be used in the node-oracledb Thin mode.
1218
+
1219
+
**Example**
1220
+
1221
+
.. code-block:: javascript
1222
+
1223
+
constoracledb=require('oracledb');
1224
+
oracledb.machine='mymachine';
1225
+
1180
1226
.. attribute:: oracledb.maxRows
1181
1227
1182
1228
This property is the maximum number of rows that are fetched by a query
@@ -1266,6 +1312,29 @@ Each of the configuration properties is described below.
1266
1312
constoracledb=require('oracledb');
1267
1313
console.log("Oracle client library version is "+oracledb.oracleClientVersionString);
1268
1314
1315
+
.. attribute:: oracledb.osUser
1316
+
1317
+
.. versionadded:: 6.7
1318
+
1319
+
This property is a string that specifies the name of the operating system
1320
+
user that initiates the database connection. This is equivalent to the
1321
+
value in the ``OSUSER`` column of the ``V$SESSION`` view.
1322
+
1323
+
This property may be overridden when creating a
1324
+
:meth:`standalone connection <oracledb.getConnection()>` or a
1325
+
:meth:`connection pool <oracledb.createPool()>`.
1326
+
1327
+
.. note::
1328
+
1329
+
This method is only supported in node-oracledb Thin mode.
1330
+
1331
+
**Example**
1332
+
1333
+
.. code-block:: javascript
1334
+
1335
+
constoracledb=require('oracledb');
1336
+
oracledb.osUser='myuser';
1337
+
1269
1338
.. attribute:: oracledb.outFormat
1270
1339
1271
1340
This property is a number that identifies the format of query rows
@@ -1592,6 +1661,29 @@ Each of the configuration properties is described below.
1592
1661
constoracledb=require('oracledb');
1593
1662
oracledb.prefetchRows=2;
1594
1663
1664
+
.. attribute:: oracledb.program
1665
+
1666
+
.. versionadded:: 6.7
1667
+
1668
+
This property is a string that specifies the name of the program
1669
+
connecting to the database. This is equivalent to the value in the
1670
+
``PROGRAM`` column of the ``V$SESSION`` view.
1671
+
1672
+
This property may be overridden when creating a
1673
+
:meth:`standalone connection <oracledb.getConnection()>` or a
1674
+
:meth:`connection pool <oracledb.createPool()>`.
1675
+
1676
+
.. note::
1677
+
1678
+
This method is only supported in node-oracledb Thin mode.
1679
+
1680
+
**Example**
1681
+
1682
+
.. code-block:: javascript
1683
+
1684
+
constoracledb=require('oracledb');
1685
+
oracledb.program='myprogram';
1686
+
1595
1687
.. attribute:: oracledb.Promise
1596
1688
1597
1689
**The ``oracledb.Promise`` property is no longer used in node-oracledb 5
@@ -1699,6 +1791,29 @@ Each of the configuration properties is described below.
1699
1791
constoracledb=require('oracledb');
1700
1792
oracledb.stmtCacheSize=30;
1701
1793
1794
+
.. attribute:: oracledb.terminal
1795
+
1796
+
.. versionadded:: 6.7
1797
+
1798
+
This property is a string that specifies the name of the terminal from
1799
+
where the connection originates. This is equivalent to the value in the
1800
+
``TERMINAL`` column of the ``V$SESSION`` view.
1801
+
1802
+
This property may be overridden when creating a
1803
+
:meth:`standalone connection <oracledb.getConnection()>` or a
1804
+
:meth:`connection pool <oracledb.createPool()>`.
1805
+
1806
+
.. note::
1807
+
1808
+
This method is only supported in node-oracledb Thin mode.
1809
+
1810
+
**Example**
1811
+
1812
+
.. code-block:: javascript
1813
+
1814
+
constoracledb=require('oracledb');
1815
+
oracledb.terminal='myterminal';
1816
+
1702
1817
.. attribute:: oracledb.thin
1703
1818
1704
1819
.. versionadded:: 6.0
@@ -1926,6 +2041,16 @@ Oracledb Methods
1926
2041
.. versionadded:: 2.1
1927
2042
1928
2043
The alias ``connectionString``.
2044
+
* - ``driverName``
2045
+
- String
2046
+
- Thin
2047
+
- .. _createpoolpoolattrsdrivername:
2048
+
2049
+
The name of the driver that is used by the client to connect to Oracle Database. This is equivalent to the value in the ``CLIENT_DRIVER`` column of the ``V$SESSION_CONNECT_INFO`` view.
2050
+
2051
+
This optional property overrides the :attr:`oracledb.driverName` property.
2052
+
2053
+
.. versionadded:: 6.7
1929
2054
* - ``walletPassword``
1930
2055
- String
1931
2056
- Thin
@@ -2022,6 +2147,26 @@ Oracledb Methods
2022
2147
See :ref:`Heterogeneous Connection Pools and Pool Proxy Authentication <connpoolproxy>` for details and examples.
2023
2148
2024
2149
.. versionadded:: 2.3
2150
+
* - ``machine``
2151
+
- String
2152
+
- Thin
2153
+
- .. _createpoolpoolattrsmachine:
2154
+
2155
+
The name of the host machine from where the connection originates. This is equivalent to the value in the ``MACHINE`` column of the ``V$SESSION`` view.
2156
+
2157
+
This optional property overrides the :attr:`oracledb.machine` property.
2158
+
2159
+
.. versionadded:: 6.7
2160
+
* - ``osUser``
2161
+
- String
2162
+
- Thin
2163
+
- .. _createpoolpoolattrsosuser:
2164
+
2165
+
The name of the operating system user that initiates the database connection. This is equivalent to the value in the ``OSUSER`` column of the ``V$SESSION`` view.
2166
+
2167
+
This optional property overrides the :attr:`oracledb.osUser` property.
2168
+
2169
+
.. versionadded:: 6.7
2025
2170
* - ``password``
2026
2171
- String
2027
2172
- Both
@@ -2053,6 +2198,16 @@ Oracledb Methods
2053
2198
See :ref:`Privileged Connections <privconn>` for more information.
2054
2199
2055
2200
.. versionadded:: 6.5.1
2201
+
* - ``program``
2202
+
- String
2203
+
- Thin
2204
+
- .. _createpoolpoolattrsprogram:
2205
+
2206
+
The name of the program connecting to the database. This is equivalent to the value in the ``PROGRAM`` column of the ``V$SESSION`` view.
2207
+
2208
+
This optional property overrides the :attr:`oracledb.program` property.
2209
+
2210
+
.. versionadded:: 6.7
2056
2211
* - ``configDir``
2057
2212
- String
2058
2213
- Thin
@@ -2179,6 +2334,16 @@ Oracledb Methods
2179
2334
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.
2180
2335
2181
2336
.. versionadded:: 6.0
2337
+
* - ``terminal``
2338
+
- String
2339
+
- Thin
2340
+
- .. _createpoolpoolattrsterminal:
2341
+
2342
+
The name of the terminal from where the connection originates. This is equivalent to the value in the ``TERMINAL`` column of the ``V$SESSION`` view.
2343
+
2344
+
This optional property overrides the :attr:`oracledb.terminal` property.
2345
+
2346
+
.. versionadded:: 6.7
2182
2347
* - ``transportConnectTimeout``
2183
2348
- Number
2184
2349
- Thin
@@ -2653,6 +2818,16 @@ Oracledb Methods
2653
2818
.. versionadded:: 2.1
2654
2819
2655
2820
The alias ``connectionString``.
2821
+
* - ``driverName``
2822
+
- String
2823
+
- Thin
2824
+
- .. _getconnectiondbattrsdrivername:
2825
+
2826
+
The name of the driver that is used by the client to connect to Oracle Database. This is equivalent to the value in the ``CLIENT_DRIVER`` column of the ``V$SESSION_CONNECT_INFO`` view.
2827
+
2828
+
This optional property overrides the :attr:`oracledb.driverName` property.
2829
+
2830
+
.. versionadded:: 6.7
2656
2831
* - ``walletPassword``
2657
2832
- String
2658
2833
- Thin
@@ -2717,6 +2892,16 @@ Oracledb Methods
2717
2892
The ``user`` (or ``username``) and ``password`` properties should not be set when ``externalAuth`` is *true*.
2718
2893
2719
2894
Note prior to node-oracledb 0.5 this property was called ``isExternalAuth``.
2895
+
* - ``machine``
2896
+
- String
2897
+
- Thin
2898
+
- .. _getconnectiondbattrsmachine:
2899
+
2900
+
The name of the host machine from where the connection originates. This is equivalent to the value in the ``MACHINE`` column of the ``V$SESSION`` view.
2901
+
2902
+
This optional property overrides the :attr:`oracledb.machine` property.
2903
+
2904
+
.. versionadded:: 6.7
2720
2905
* - ``matchAny``
2721
2906
- Boolean
2722
2907
- Thick
@@ -2741,12 +2926,32 @@ Oracledb Methods
2741
2926
See :ref:`Changing Passwords and Connecting with an Expired Password <changingpassword>`.
2742
2927
2743
2928
.. versionadded:: 2.2
2929
+
* - ``osUser``
2930
+
- String
2931
+
- Thin
2932
+
- .. _getconnectiondbattrsosuser:
2933
+
2934
+
The name of the operating system user that initiates the database connection. This is equivalent to the value in the ``OSUSER`` column of the ``V$SESSION`` view.
2935
+
2936
+
This optional property overrides the :attr:`oracledb.osUser` property.
2937
+
2938
+
.. versionadded:: 6.7
2744
2939
* - ``poolAlias``
2745
2940
- String
2746
2941
- Both
2747
2942
- .. _getconnectiondbattrspoolalias:
2748
2943
2749
2944
Specifies which previously created pool in the :ref:`connection pool cache <connpoolcache>` to obtain the connection from. See :ref:`Pool Alias <getconnectionpoolalias>`.
2945
+
* - ``program``
2946
+
- String
2947
+
- Thin
2948
+
- .. _getconnectiondbattrsprogram:
2949
+
2950
+
The name of the program connecting to the database. This is equivalent to the value in the ``PROGRAM`` column of the ``V$SESSION`` view.
2951
+
2952
+
This optional property overrides the :attr:`oracledb.program` property.
2953
+
2954
+
.. versionadded:: 6.7
2750
2955
* - ``configDir``
2751
2956
- String
2752
2957
- Thin
@@ -2885,6 +3090,16 @@ Oracledb Methods
2885
3090
For node-oracledb Thick mode, use an :ref:`Easy Connect string <easyconnect>` or a :ref:`Connect Descriptor string <embedtns>` instead.
2886
3091
2887
3092
.. versionadded:: 6.0
3093
+
* - ``terminal``
3094
+
- String
3095
+
- Thin
3096
+
- .. _getconnectiondbattrsterminal:
3097
+
3098
+
The name of the terminal from where the connection originates. This is equivalent to the value in the ``TERMINAL`` column of the ``V$SESSION`` view.
3099
+
3100
+
This optional property overrides the :attr:`oracledb.terminal` property.
0 commit comments