temporal.axisCreate

temporal.axiscreatetemporalaxiscreate

/apidoc/8.0/temporal:axis-create.xml

This function constructs an axis definition based on the existing range indexes that can be added to a collection in subsequent API calls. The axis definition is stored in the schema database.

For details on how to create an axis, see Create System and Valid Axes in the Temporal Developer's Guide

A TEMPORAL-NONDATETIME exception is thrown if range index scalar type is not dateTime. A TEMPORAL-DUPAXIS exception is thrown if the axis already exists.

The name to be used to identify the axis.

axis-name

String

A reference to a range index to be used as the start of the time period.

start-range-index

cts.reference

A reference to a range index to be used as the end of the time period.

end-range-index

cts.reference

String

var temporal = require("/MarkLogic/temporal.xqy");

temporal.axisRemove("system");
temporal.axisRemove("valid");
var output = new Array();
output.push(
  temporal.axisCreate(
   "system",
   cts.elementReference(xs.QName("systemStart")),
   cts.elementReference(xs.QName("systemEnd"))) 
  );

output.push(
  temporal.axisCreate(
   "valid",
   cts.elementReference(xs.QName("validStart")),
   cts.elementReference(xs.QName("validEnd"))) 
  );
output;

// First removes, then creates two axes, named "system" and "valid",
// from the element range indexes, "systemStart", "systemEnd",
// "validStart", and "validEnd".  Then it returns the IDs of the
// new axes.