MarkLogic 12 Product Documentation

qbe.byExample

qbe.byExample(
   example as Item
) as cts.query

Summary

This function transforms a query by example into a cts.query object.

Usage Notes

To learn how to specify a query by example, see Searching Using Query By Example in the Search Developer's Guide. Important: The byExample function has the same limitations as the jsearch.byExample function:

• You cannot use the constraint, datatype, filtered, response, or score QBE properties. Instead, use the capabilities of the function to which you pass the returned cts.query .
• Your database configuration must include a range index definition for any range queries. You cannot avoid or defer index creation.

The returned cts.query can be passed to a cts.search call, an Optic API prototype.where operation, or any other call that takes a cts.query object.

Example

const qbe = require('/MarkLogic/appservices/search/qbe.xqy');

const query = qbe.byExample({
  title:{$word: 'sawyer'},
  $and:[
    {price:{$ge:  8.00}},
    {price:{$lt: 10.00}}
  ]
});
cts.search(query);