MarkLogic 9 Product Documentation

jsearch.udf

jsearch.udf(
   plugin as xs.string,
   aggregate as xs.string,
   argument as 
) as LexiconDefinition

Summary

Identifies a UDF (User Defined Function) to the ValuesSearch.aggregate function for aggregating values from a single index or to the TuplesSearch.aggregate function for aggregating co-occurring values from multiple indexes. The native plugin implementing the UDF must be installed on all hosts.

See Also

• ValuesSearch.aggregate
• TuplesSearch.aggregate
• Computing Aggregates Over Range Indexes in the Search Developer's Guide

Example

// Compute an aggregate using a UDF name "count", installed in
// in the modules database under native/sampleplugin
const jsearch = require('/MarkLogic/jsearch.sjs');
jsearch.values('price')
  .aggregate(jsearch.udf('native/sampleplugin', 'count'))
  .result();