Skip to content

Commit 43a4ecc

Browse files
committed
Fix an unbalanced paren in doc and do some tidy up
1 parent 1d4736a commit 43a4ecc

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

doc/api.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ This property may be overridden in an [`execute()`](#executeoptions)
11651165
call.
11661166

11671167
To improve database efficiency, SQL queries should use a row limiting
1168-
clause like [OFFSET / FETCH](#pagingdata) or equivalent. The `maxRows`
1168+
clause like [`OFFSET` / `FETCH`](#pagingdata) or equivalent. The `maxRows`
11691169
property can be used to stop badly coded queries from returning
11701170
unexpectedly large numbers of rows.
11711171

@@ -7461,7 +7461,7 @@ Any rows beyond the `maxRows` limit are not returned. If `maxRows` is
74617461
0, then the number of rows is only limited by Node.js memory.
74627462
74637463
To improve database efficiency, SQL queries should use a row limiting
7464-
clause like [OFFSET / FETCH](#pagingdata) or equivalent. The `maxRows`
7464+
clause like [`OFFSET` / `FETCH`](#pagingdata) or equivalent. The `maxRows`
74657465
property can be used to stop badly coded queries from returning
74667466
unexpectedly large numbers of rows.
74677467
@@ -8138,9 +8138,9 @@ How to do 'web pagination' is discussed in this section. For each
81388138
of rows from a table. Since the query will be executed more than
81398139
once, make sure to use bind variables for row numbers and row limits.
81408140
8141-
Oracle Database 12c SQL has an `OFFSET` / `FETCH` clause (See [Row
8142-
Limiting: Examples][5], which is similar to the LIMIT keyword of
8143-
MySQL.
8141+
Oracle Database 12c SQL introduced an `OFFSET` / `FETCH` clause which
8142+
is similar to the LIMIT keyword of MySQL. See [Row Limiting:
8143+
Examples][5] in the Oracle documentation. A node-oracledb example is:
81448144
81458145
```javascript
81468146
var myoffset = 0; // do not skip any rows (start at row 1)
@@ -8155,7 +8155,7 @@ connection.execute(
81558155
. . .
81568156
```
81578157
8158-
See [rowlimit.js][84].
8158+
A runnable example is in [rowlimit.js][84].
81598159
81608160
You can use a basic [`execute()`](#execute) or a
81618161
[ResultSet](#resultsetclass), or [`queryStream()`](#querystream) with
@@ -8173,10 +8173,8 @@ efficient to let Oracle Database do the row selection in the SQL query
81738173
and only return the exact number of rows required to node-oracledb.
81748174
81758175
For Oracle Database 11g and earlier there are several alternative ways
8176-
to limit the number of rows returned. Refer to [Oracle Magazine][85]
8177-
for details.
8178-
8179-
The old, canonical paging query is:
8176+
to limit the number of rows returned. The old, canonical paging query
8177+
is:
81808178
81818179
```SQL
81828180
SELECT *
@@ -8211,6 +8209,9 @@ SELECT last_name FROM
82118209
WHERE myr BETWEEN 1 and 20
82128210
```
82138211
8212+
Refer to [On Top-n and Pagination Queries][85] in Oracle Magazine for
8213+
details.
8214+
82148215
#### <a name="autoincrement"></a> 13.1.8 Auto-Increment Columns
82158216
82168217
From Oracle Database 12c you can create tables with auto-incremented
@@ -11979,8 +11980,8 @@ When upgrading from node-oracledb version 1.13 to version 2.0:
1197911980
1198011981
- For [direct fetches](#fetchingrows) that relied on the version 1
1198111982
default value of [`maxRows`](#propdbmaxrows) to limit the number of
11982-
returned rows to 100, it is recommended to use an [OFFSET /
11983-
FETCH](#pagingdata) query clause. Alternatively explicitly set
11983+
returned rows to 100, it is recommended to use an [`OFFSET` /
11984+
`FETCH`](#pagingdata) query clause. Alternatively explicitly set
1198411985
`maxRows` to 100.
1198511986
1198611987
- Review and update code that checks for specific *NJS-XXX* or

0 commit comments

Comments
 (0)