Skip to content

Commit 1540402

Browse files
committed
Add section on privileged connections
1 parent 96d1eda commit 1540402

File tree

1 file changed

+43
-10
lines changed

1 file changed

+43
-10
lines changed

doc/api.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,10 @@ limitations under the License.
174174
- 8.3.4 [Connection Pool Pinging](#connpoolpinging)
175175
- 8.4 [Database Resident Connection Pooling (DRCP)](#drcp)
176176
- 8.5 [External Authentication](#extauth)
177-
- 8.6 [Securely Encrypting Network Traffic to Oracle Database](#securenetwork)
178-
- 8.7 [Connections and High Availability](#connectionha)
179-
- 8.8 [Optional Client Configuration Files](#tnsadmin)
177+
- 8.6 [Privileged Connections](#privconn)
178+
- 8.7 [Securely Encrypting Network Traffic to Oracle Database](#securenetwork)
179+
- 8.8 [Connections and High Availability](#connectionha)
180+
- 8.9 [Optional Client Configuration Files](#tnsadmin)
180181
9. [SQL Execution](#sqlexecution)
181182
- 9.1 [SELECT Statements](#select)
182183
- 9.1.1 [Fetching Rows with Direct Fetches](#fetchingrows)
@@ -524,10 +525,10 @@ oracledb.BIND_OUT // (3003) Direction for OUT binds
524525

525526
#### <a name="oracledbconstantsprivilege"></a> 3.1.5 Privileged Connection Constants
526527

527-
Constants for [`getConnection()`](#getconnectiondb) `privilege`
528-
properties.
528+
Constants for [`getConnection()`](#getconnectiondb)
529+
[`privilege`](#getconnectiondbattrsprivilege) properties.
529530

530-
These specify what [privilege](#getconnectiondbattrsprivilege) should
531+
These specify what privilege should
531532
be used by the connection that is being established.
532533

533534
```
@@ -1192,7 +1193,7 @@ console.log("Driver version is " + oracledb.versionString);
11921193
readonly String versionSuffix
11931194
```
11941195

1195-
This readonly property gives a string representing the version suffix (e.g. "-dev" or "-beta") or the value undefined if no version suffix is present.
1196+
This readonly property gives a string representing the version suffix (e.g. "-dev" or "-beta") or an empty string if no version suffix is present.
11961197

11971198
##### Example
11981199

@@ -1581,6 +1582,8 @@ The privilege to use when establishing connection to the database. This
15811582
optional property should be one of the
15821583
[privileged connection constants](#oracledbconstantsprivilege).
15831584

1585+
See [Privileged Connections](#privconn) for more information.
1586+
15841587
Note only non-pooled connections can be privileged.
15851588

15861589
See the [Database Administrators Guide][90] for information on
@@ -3490,7 +3493,37 @@ of open connections exceeds `poolMin` and connections are idle for
34903493
more than the [`poolTimeout`](#propdbpooltimeout) seconds, then the
34913494
number of open connections does not fall below `poolMin`.
34923495
3493-
### <a name="securenetwork"></a> 8.6 Securely Encrypting Network Traffic to Oracle Database
3496+
### <a name="privconn"></a> 8.6 Privileged Connections
3497+
3498+
Database privileges such as `SYSDBA` can be obtained when using
3499+
standalone connections. Use one of the [Privileged Connection
3500+
Constants](#oracledbconstantsprivilege) with the connection
3501+
[`privilege`](#getconnectiondbattrsprivilege) property, for example:
3502+
3503+
```
3504+
oracledb.getConnection(
3505+
{
3506+
user : 'sys',
3507+
password : 'secret',
3508+
connectString : 'localhost/orclpdb',
3509+
privilege : oracledb.SYSDBA
3510+
},
3511+
function(err, connection) {
3512+
if (err)
3513+
console.error(err);
3514+
else
3515+
console.log('I have power');
3516+
}
3517+
);
3518+
```
3519+
3520+
Administrative privileges can allow access to a database instance even
3521+
when the database is not open. Control of these privileges is totally
3522+
outside of the database itself. Care must be taken with
3523+
authentication to ensure security. See the [Database Administrators
3524+
Guide][90] for information.
3525+
3526+
### <a name="securenetwork"></a> 8.7 Securely Encrypting Network Traffic to Oracle Database
34943527
34953528
Data transferred between Oracle Database and the Oracle client
34963529
libraries used by node-oracledb can be [encrypted][30] so that
@@ -3556,7 +3589,7 @@ manual also contains information about other important security
35563589
features that Oracle Database provides, such Transparent Data
35573590
Encryption of data-at-rest in the database.
35583591
3559-
### <a name="connectionha"></a> 8.7 Connections and High Availability
3592+
### <a name="connectionha"></a> 8.8 Connections and High Availability
35603593
35613594
For applications that need to be highly available, you may want to
35623595
configure your OS network settings and Oracle Net (which handles
@@ -3573,7 +3606,7 @@ setting [`ENABLE=BROKEN`][36].
35733606
Other [Oracle Network Services][37] options may also be useful for
35743607
high availability and performance tuning.
35753608
3576-
### <a name="tnsadmin"></a> 8.8 Optional Client Configuration Files
3609+
### <a name="tnsadmin"></a> 8.9 Optional Client Configuration Files
35773610
35783611
Optional Oracle Client configuration files are read when node-oracledb
35793612
is loaded. These files affect connections and applications. Common

0 commit comments

Comments
 (0)