Server-side JavaScript

Working Together

MarkLogic provides two languages for code running in the database: Server-side JavaScript and XQuery. These languages can be used together, allowing mixed teams to make use of each other's work.

Calling XQuery from Server-side JavaScript

JavaScript modules can import XQuery modules and access public functions and variables, just as an importing XQuery file could. XQuery names are automatically converted to lowerCamelCase in JavaScript. This gives the JavaScript developer access to existing XQuery code, whether developed by MarkLogic or by an in-house team.

The example below uses MarkLogic's Admin API to create a dateTime range index on the "registered" property.

Use CommonJS syntax to import an XQuery library module. Imported functions are available in their lowerCamelCase form. For example, my:do-something(…) in XQuery would be called as

var my = require("path/to/my.xqy") my.doSomething(…)

in JavaScript.

var admin = require("/MarkLogic/admin"); // Use the (XQuery) Admin APIs to create some indexes. var config = admin.getConfiguration(); try { // Create a dateTime index on the registered property. For the purposes of // creating range indexes a JSON property is the same as an XML element (i.e. // this will also add XML elements named "registered" in no namespace to this // index.) Since JSON lacks a native Date type (though JavaScript has one), // the indexer automatically parses strings that are formatted as ISO8601 // dates, e.g. {"registered": "2014-01-31T19:57:33+08:00"} config = admin.databaseAddRangeElementIndex(config, xdmp.database(), admin.databaseRangeElementIndex("dateTime", null, "registered", null, true, "ignore") ); } catch(err) { if(err.name != "ADMIN-DUPLICATECONFIGITEM") { throw err; } // Ignore the error if we've already got this index } try { // JSON nodes support full XPath evaluation. Similarly, you can use XPath to specify path indexes on JSON documents. config = admin.databaseAddRangePathIndex(config, xdmp.database(), admin.databaseRangePathIndex(xdmp.database(), "double", "balance/value", null, false, "ignore") ); } catch(err) { if(err.name != "ADMIN-DUPLICATECONFIGITEM") { throw err; } } admin.saveConfiguration(config);

Calling JavaScript from XQuery

XQuery modules can evaluate JavaScript (and SQL and SPARQL). xdmp:javascript-eval() allows access to external variables and does all of the mapping between XQuery and JavaScript data types.

(: : Evaluate JavaScript from XQuery, passing in external variables and returning : results as XQuery types. :) xdmp:javascript-eval( "var result = []; for(var p in param) {result.push(p); result.push(param[p]);} result;", (xs:QName("param"), object-node { "a": "A", "b": "B"}) )