MarkLogic Server 11.0 Product DocumentationTuplesSearch.withOptions
TuplesSearch.withOptions( option as object ) as TuplesSearch
Summary
Configure advanced options for a tuples query.
| Parameters | |
|---|---|
| option | A configuration object for enabling special features of the tuples query. See the Usage Notes for details. |
Usage Notes
You can specify the following properties in the configuration object:
tuples- An array of string options to pass through to
cts.valueTuplesfor fine-tuning the configuration from the other tuples search clauses.qualityWeight- A number specifying the weight for the search.
forestNames- an array of strings for restricting the query to tuples of documents in the specified forests.
See Also
- Using Options to Control a Query in the Search Developer's Guide
- Finding Value Co-Occurrences in Lexicons and Indexes in the Search Developer's Guide
Example
const jsearch = require('/MarkLogic/jsearch.sjs');
jsearch.tuples([
cts.jsonPropertyReference('format'),
cts.jsonPropertyReference('price')])
.withOptions({tuples: ['proximity=5']})
.result()