Skip to content

Commit bbd8be5

Browse files
committed
Update outFormat section
1 parent 98e2327 commit bbd8be5

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

doc/api.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -492,12 +492,12 @@ Boolean extendedMetaData
492492
Determines whether additional metadata is available for queries and
493493
for REF CURSORs returned from PL/SQL blocks.
494494

495-
The default value for `extendedMetaData` is `false`. With this value,
495+
The default value for `extendedMetaData` is *false*. With this value,
496496
the [`result.metaData`](#execmetadata)
497497
[`result.resultSet.metaData`](#rsmetadata) objects only include column
498498
names.
499499

500-
If `extendedMetaData` is `true` then `metaData` will contain
500+
If `extendedMetaData` is *true* then `metaData` will contain
501501
additional attributes. These are listed in
502502
[Result Object Properties](#execmetadata).
503503

@@ -666,10 +666,15 @@ console.log("Oracle client library version number is " + oracledb.oracleClientVe
666666
Number outFormat
667667
```
668668

669-
The format of rows fetched when using the [`execute()`](#execute)
670-
call. This can be either of the [Oracledb
671-
constants](#oracledbconstantsoutformat) `ARRAY` or `OBJECT`. The default value
672-
is `ARRAY` which is more efficient.
669+
The format of query rows fetched when
670+
using [`connection.execute()`](#execute)
671+
or [`connection.queryStream()`](#querystream). It affects
672+
both [ResultSet](#propexecresultset) and non-ResultSet queries. It
673+
can be used for top level queries and REF CURSOR output.
674+
675+
This can be either of
676+
the [Oracledb constants](#oracledbconstantsoutformat) `ARRAY` or
677+
`OBJECT`. The default value is `ARRAY` which is more efficient.
673678

674679
If specified as `ARRAY`, each row is fetched as an array of column
675680
values.
@@ -681,7 +686,9 @@ Oracle's standard name-casing rules. It will commonly be uppercase,
681686
since most applications create tables using unquoted, case-insensitive
682687
names.
683688

684-
This property may be overridden in an [`execute()`](#executeoptions) call.
689+
This property may be overridden in
690+
an [`execute()`](#executeoptions)
691+
or [`queryStream()`](#querystream) call.
685692

686693
##### Example
687694

@@ -690,6 +697,8 @@ var oracledb = require('oracledb');
690697
oracledb.outFormat = oracledb.ARRAY;
691698
```
692699

700+
See [Query Output Formats](#queryoutputformats) for more examples.
701+
693702
#### <a name="propdbpoolincrement"></a> 3.2.10 `oracledb.poolIncrement`
694703

695704
```
@@ -1794,7 +1803,7 @@ Boolean resultSet
17941803

17951804
Determines whether query results should be returned as a
17961805
[`ResultSet`](#resultsetclass) object or directly. The default is
1797-
`false`.
1806+
*false*.
17981807

17991808
##### <a name="executecallback"></a> 4.2.5.4 `execute()`: Callback Function
18001809

@@ -1824,7 +1833,7 @@ details of columns for the select list. For non queries, this property is undef
18241833

18251834
Each column's `name` is always given. If the
18261835
[`oracledb.extendedMetaData`](#propdbextendedmetadata) or `execute()` option
1827-
[`extendedMetaData`](#propexecextendedmetadata) are `true` then
1836+
[`extendedMetaData`](#propexecextendedmetadata) are *true* then
18281837
additional information is included.
18291838

18301839
- `name`: The column name follows Oracle's standard name-casing rules. It will commonly be uppercase, since most applications create tables using unquoted, case-insensitive names.
@@ -1865,7 +1874,7 @@ Object resultSet
18651874
```
18661875

18671876
For `SELECT` statements when the [`resultSet`](#executeoptions)
1868-
option is `true`, use the `resultSet` object to fetch rows. See
1877+
option is *true*, use the `resultSet` object to fetch rows. See
18691878
[ResultSet Class](#resultsetclass).
18701879

18711880
###### <a name="execrows"></a> 4.2.5.4.4 `rows`
@@ -1875,7 +1884,7 @@ Array rows
18751884
```
18761885

18771886
For `SELECT` statements where the [`resultSet`](#executeoptions) option is
1878-
`false` or unspecified, `rows` contains an array of fetched rows. It
1887+
*false* or unspecified, `rows` contains an array of fetched rows. It
18791888
will be NULL if there is an error or the SQL statement was not a
18801889
SELECT statement. By default, the rows are in an array of column
18811890
value arrays, but this can be changed to arrays of objects by setting
@@ -2344,7 +2353,7 @@ CURSOR columns.
23442353

23452354
Each column's `name` is always given. If the
23462355
[`oracledb.extendedMetaData`](#propdbextendedmetadata) or `execute()` option
2347-
[`extendedMetaData`](#propexecextendedmetadata) are `true` then
2356+
[`extendedMetaData`](#propexecextendedmetadata) are *true* then
23482357
additional information is included.
23492358

23502359
See [`result.metaData`](#execmetadata) for the available attributes.
@@ -2861,7 +2870,7 @@ with [`connection.close()`](#connectionclose). If `poolMax` has not
28612870
been reached, then connections can be satisfied and are not queued.
28622871
28632872
The pool queue can be disabled by setting the pool property
2864-
[`queueRequests`](#propdbqueuerequests) to `false`. When the queue is
2873+
[`queueRequests`](#propdbqueuerequests) to *false*. When the queue is
28652874
disabled, `getConnection()` requests to a pool that cannot immediately be
28662875
satisfied will return an error.
28672876
@@ -3184,7 +3193,7 @@ return a known small number of rows, non-Result Set queries may have
31843193
less overhead.
31853194
31863195
A Result Set is created when the `execute()` option property
3187-
[`resultSet`](#executeoptions) is `true`. Result Set rows can be
3196+
[`resultSet`](#executeoptions) is *true*. Result Set rows can be
31883197
fetched using [`getRow()`](#getrow) or [`getRows()`](#getrows) on the
31893198
`execute()` callback function's `result.resultSet` parameter property.
31903199
@@ -3450,7 +3459,7 @@ case-insensitive column names.
34503459
34513460
More metadata is included when the
34523461
[`oracledb.extendedMetaData`](#propdbextendedmetadata) or `connection.execute()` option
3453-
[`extendedMetaData`](#propexecextendedmetadata) is `true`. For
3462+
[`extendedMetaData`](#propexecextendedmetadata) is *true*. For
34543463
example:
34553464
34563465
```javascript

0 commit comments

Comments
 (0)