Skip to content

Commit 901c50c

Browse files
committed
Update SODA hint documentation
1 parent 0cbaf15 commit 901c50c

File tree

1 file changed

+35
-28
lines changed

1 file changed

+35
-28
lines changed

doc/api.md

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6682,15 +6682,16 @@ hint(String hint)
66826682

66836683
##### Description
66846684

6685-
The `hint()` value can be used to pass one or more Oracle hints to [terminal
6685+
The `hint()` value can be used to pass an Oracle hint to [terminal
66866686
SodaOperation Methods](#sodaoperationclassterm). It is string in the same
6687-
format as [SQL hints][196] but without any comment characters, for example
6688-
`"MONITOR"`. While you could use this to pass any SQL hint, the hints
6689-
`"MONITOR"` (turn on monitoring) and `"NO_MONITOR"` (turn off monitoring) are
6690-
the most useful. Use of this function requires Oracle Client 21.3 or higher (or
6691-
Oracle Client 19 from 19.11).
6687+
format as a [SQL hint][196] but without any comment characters, for example
6688+
`hint("MONITOR")`. Pass only the hint `"MONITOR"` (turn on monitoring) or
6689+
`"NO_MONITOR"` (turn off monitoring). See the Oracle Database SQL Tuning Guide
6690+
documentation [MONITOR and NO_MONITOR Hints][201] and [Monitoring Database
6691+
Operations][202] for more information.
66926692

6693-
This method was added in node-oracledb 5.2.
6693+
This method was added in node-oracledb 5.2. It requires Oracle Client 21.3 or
6694+
higher (or Oracle Client 19 from 19.11).
66946695

66956696
###### <a name="sodaoperationclasskey"></a> 10.2.4.1.1.4 `sodaOperation.key()`
66966697

@@ -7268,16 +7269,18 @@ keys (in default collections), can be found. Content itself is not returned for
72687269
performance reasons. When inserting multiple documents, using
72697270
`insertManyAndGet()` is recommended in preference to `insertOneAndGet()`.
72707271

7271-
The `options` object can have one string property `hint`. The hints are strings
7272-
without SQL comment characters, for example `{ hint: "MONITOR" }`. While you
7273-
could use this to pass any [SQL hint][196], the hints `"MONITOR"` (turn on
7274-
monitoring) and `"NO_MONITOR"` (turn off monitoring) are the most useful. Use
7275-
of the `hint` property requires Oracle Client 21.3 or higher (or Oracle Client
7276-
19 from 19.11).
7272+
The `options` object can have one string property `hint`. Hints are strings
7273+
without SQL comment characters, for example `{ hint: "MONITOR" }`. Use only
7274+
the hint `"MONITOR"` (turn on monitoring) or `"NO_MONITOR"` (turn off
7275+
monitoring). See the Oracle Database SQL Tuning Guide documentation [MONITOR
7276+
and NO_MONITOR Hints][201] and [Monitoring Database Operations][202] for more
7277+
information.
72777278

72787279
This method is in Preview status and should not be used in production.
72797280

7280-
This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or higher.
7281+
This method was added in node-oracledb 4.0. It requires Oracle Client 18.5 or
7282+
higher. Use of the `hint` property requires Oracle Client 21.3 or higher (or
7283+
Oracle Client 19 from 19.11).
72817284

72827285
This method accepts an options parameter from node-oracledb 5.2 onwards.
72837286

@@ -7389,19 +7392,20 @@ If you want to insert the document again, use the original `newDocumentContent`
73897392
or `newSodaDocument`. Alternatively construct a new object from the returned
73907393
document and add content.
73917394

7392-
The `options` object can have one string property `hint`. The hints are strings
7393-
without SQL comment characters, for example `{ hint: "MONITOR" }`. While you
7394-
could use this to pass any [SQL hint][196], the hints `"MONITOR"` (turn on
7395-
monitoring) and `"NO_MONITOR"` (turn off monitoring) are the most useful. Use
7396-
of the `hint` property requires Oracle Client 21.3 or higher (or Oracle Client
7397-
19 from 19.11).
7395+
The `options` object can have one string property `hint`. Hints are strings
7396+
without SQL comment characters, for example `{ hint: "MONITOR" }`. Use only
7397+
the hint `"MONITOR"` (turn on monitoring) or `"NO_MONITOR"` (turn off
7398+
monitoring). See the Oracle Database SQL Tuning Guide documentation [MONITOR
7399+
and NO_MONITOR Hints][201] and [Monitoring Database Operations][202] for more
7400+
information.
73987401

73997402
If [`oracledb.autoCommit`](#propdbisautocommit) is *true*, and
74007403
`insertOneAndGet()` succeeds, then any open transaction on the
74017404
connection is committed.
74027405

74037406
This method was added in node-oracledb 3.0. This method accepts an options
7404-
parameter from node-oracledb 5.2 onwards.
7407+
parameter from node-oracledb 5.2 onwards. Use of the `hint` property requires
7408+
Oracle Client 21.3 or higher (or Oracle Client 19 from 19.11).
74057409

74067410
##### <a name="sodacollinsertoneandgetparams"></a> 10.2.9.1 `insertOneAndGet()`: Parameters
74077411

@@ -7486,15 +7490,16 @@ why `saveAndGet()` accepts only a [SodaDocument](#sodadocumentclass), unlike
74867490
keys, then the behavior is exactly the same as
74877491
`sodaCollection.insertOneAndGet()`.
74887492

7489-
The `options` object can have one string property `hint`. The hints are strings
7490-
without SQL comment characters, for example `{ hint: "MONITOR" }`. While you
7491-
could use this to pass any [SQL hint][196], the hints `"MONITOR"` (turn on
7492-
monitoring) and `"NO_MONITOR"` (turn off monitoring) are the most useful. Use
7493-
of the `hint` property requires Oracle Client 21.3 or higher (or Oracle Client
7494-
19 from 19.11).
7493+
The `options` object can have one string property `hint`. Hints are strings
7494+
without SQL comment characters, for example `{ hint: "MONITOR" }`. Use only
7495+
the hint `"MONITOR"` (turn on monitoring) or `"NO_MONITOR"` (turn off
7496+
monitoring). See the Oracle Database SQL Tuning Guide documentation [MONITOR
7497+
and NO_MONITOR Hints][201] and [Monitoring Database Operations][202] for more
7498+
information.
74957499

74967500
This method was added in node-oracledb 5.0. It requires Oracle Client 19.9 or
7497-
later, and Oracle Database 18.3 or later.
7501+
later, and Oracle Database 18.3 or later. Use of the `hint` property requires
7502+
Oracle Client 21.3 or higher (or Oracle Client 19 from 19.11).
74987503

74997504
This method accepts an options parameter from node-oracledb 5.2 onwards.
75007505

@@ -17580,3 +17585,5 @@ can be asked at [AskTom][158].
1758017585
[198]: https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-951568BF-D798-4456-8478-15FEEBA0C78E
1758117586
[199]: https://blogs.oracle.com/oraclemagazine/build-rest-apis-for-nodejs-part-1
1758217587
[200]: https://blogs.oracle.com/opal/demo:-graphql-with-node-oracledb
17588+
[201]: https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-19E0F73C-A959-41E4-A168-91E436DEE1F1
17589+
[202]: https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-C941CE9D-97E1-42F8-91ED-4949B2B710BF

0 commit comments

Comments
 (0)