Skip to content

Commit 6d119cf

Browse files
committed
Add some cross-reference links
1 parent 8014f63 commit 6d119cf

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
@@ -1228,7 +1228,7 @@ Boolean dbObjectAsPojo
12281228
Specify whether [Oracle Database named objects or collections](#objects)
12291229
that are queried should be returned to the application as "plain old JavaScript
12301230
objects" or kept as database-backed objects. This option also applies to output
1231-
`BIND_OUT` bind variables.
1231+
`BIND_OUT` [bind variables](#bind).
12321232

12331233
Note that LOBs in objects will be represented as [Lob](#lobclass) instances and
12341234
will not be String or Buffer, regardless of any `fetchAsString`,
@@ -4368,7 +4368,7 @@ promise = getStatementInfo(String sql);
43684368

43694369
Parses a SQL statement and returns information about it. This is most
43704370
useful for finding column names of queries, and for finding the names
4371-
of bind variables used.
4371+
of [bind variables](#bind) used.
43724372

43734373
This method performs a [round-trip](#roundtrips) to the database, so
43744374
unnecessary calls should be avoided.
@@ -5486,8 +5486,8 @@ This read-only attribute shows the type of Lob being used. It will have the
54865486
value of one of the constants [`oracledb.BLOB`](#oracledbconstantsnodbtype),
54875487
[`oracledb.CLOB`](#oracledbconstantsnodbtype) or
54885488
[`oracledb.NCLOB`](#oracledbconstantsnodbtype). The value is derived from the
5489-
bind type when using LOB bind variables, or from the column type when a LOB is
5490-
returned by a query.
5489+
bind type when using [LOB bind variables](#lobbinds), or from the column type
5490+
when a LOB is returned by a query.
54915491

54925492
### <a name="lobmethods"></a> 7.2 Lob Methods
54935493

@@ -11540,7 +11540,8 @@ discussed in those links.
1154011540
'Web pagination' and limiting the maximum number of rows are discussed in this
1154111541
section. For each 'page' of results, a SQL query is executed to get the
1154211542
appropriate set of rows from a table. Since the query will be executed more
11543-
than once, make sure to use bind variables for row numbers and row limits.
11543+
than once, make sure to use [bind variables](#bind) for row numbers and row
11544+
limits.
1154411545

1154511546
Oracle Database 12c SQL introduced an `OFFSET` / `FETCH` clause which
1154611547
is similar to the `LIMIT` keyword of MySQL. See [Row Limiting:
@@ -11744,9 +11745,9 @@ solutions:
1174411745
For more information, see the [Statement Caching](#stmtcache)
1174511746
documentation.
1174611747

11747-
- Use bind variables otherwise each variant of the statement will have
11748-
its own statement cache entry and cursor. With appropriate binding
11749-
only one entry and cursor will be needed.
11748+
- Use [bind variables](#bind) otherwise each variant of the statement will have
11749+
its own statement cache entry and cursor. With appropriate binding only one
11750+
entry and cursor will be needed.
1175011751

1175111752
- Set the database's [*open_cursors*][47] parameter appropriately.
1175211753
This parameter specifies the maximum number of cursors that each
@@ -12089,10 +12090,10 @@ Redefinition][98] for more information about EBR.
1208912090

1209012091
### <a name="implicitresults"></a> 17.6 Implicit Results
1209112092

12092-
Oracle Implicit Results allow queries in PL/SQL to be returned to
12093-
Node.js without requiring REF CURSORS or bind variables. Implicit
12094-
Results requires node-oracledb 4.0, Oracle Database 12.1 or later, and
12095-
Oracle Client 12.1 or later.
12093+
Oracle Implicit Results allow queries in PL/SQL to be returned to Node.js
12094+
without requiring REF CURSORS or [bind variables](#bind). Implicit Results
12095+
requires node-oracledb 4.0, Oracle Database 12.1 or later, and Oracle Client
12096+
12.1 or later.
1209612097

1209712098
PL/SQL code uses `DBMS_SQL.RETURN_RESULT()` to return query results.
1209812099
These are accessible in the `execute()` callback

0 commit comments

Comments
 (0)