MarkLogic Server 11.0 Product Documentation

DocumentsSearch.where

DocumentsSearch.where(
   queries as cts.query
) as DocumentsSearch

Summary

Specifies which documents to match based on the indexes over the documents.

Usage Notes

Apply this method to the output from jsearch.documents. You can optionally follow it with "clauses" such as orderBy slice, or map. Query results are not generated until you call DocumentsSearch.result.

You can construct the input queries using cts.parse, jsearch.byExample, a cts.query constructor such as cts.jsonPropertyWordQuery or cts.elementValueQuery, or any other function that returns a cts.query object.

See Also

• Searching Documents in the Search Developer's Guide
• Creating a cts.query in the Search Developer's Guide

Example

// A documents query composed from a QBE, a string query, and a cts.query
const jsearch = require('/MarkLogic/jsearch.sjs');
jsearch.documents()
  .where([
    jsearch.byExample({author: 'Mark Twain'}),
    cts.parse('price LT 10',
              {price: cts.jsonPropertyReference('price')}),
    cts.directoryQuery('/books/')])
  .orderBy('title')
  .slice(0,3)
  .result()